2017-04-15 00:14:28 +03:00
<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > etcd3< / title >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "stylesheet" href = "assets/css/main.css" >
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
< div class = "table-cell" id = "tsd-search" data-index = "assets/js/search.js" data-base = "." >
< div class = "field" >
< label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label >
< input id = "tsd-search-field" type = "text" / >
< / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li >
< / ul >
< a href = "index.html" class = "title" > etcd3< / a >
< / div >
< div class = "table-cell" id = "tsd-widgets" >
< div id = "tsd-filter" >
< a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a >
< div class = "tsd-filter-group" >
< div class = "tsd-select" id = "tsd-filter-visibility" >
< span class = "tsd-select-label" > All< / span >
< ul class = "tsd-select-list" >
< li data-value = "public" > Public< / li >
< li data-value = "protected" > Public/Protected< / li >
< li data-value = "private" class = "selected" > All< / li >
< / ul >
< / div >
< input type = "checkbox" id = "tsd-filter-inherited" checked / >
< label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label >
< input type = "checkbox" id = "tsd-filter-externals" checked / >
< label class = "tsd-widget" for = "tsd-filter-externals" > Externals< / label >
< input type = "checkbox" id = "tsd-filter-only-exported" / >
< label class = "tsd-widget" for = "tsd-filter-only-exported" > Only exported< / label >
< / div >
< / div >
< a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a >
< / div >
< / div >
< / div >
< / div >
< div class = "tsd-page-title" >
< div class = "container" >
< ul class = "tsd-breadcrumb" >
< li >
< a href = "globals.html" > Globals< / a >
< / li >
< / ul >
< h1 > etcd3< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< div class = "tsd-panel tsd-typography" >
2017-06-03 19:26:50 +03:00
< h1 id = "etcd3-build-status-https-travis-ci-org-mixer-etcd3-svg-branch-master-https-travis-ci-org-mixer-etcd3-" > etcd3 < a href = "https://travis-ci.org/mixer/etcd3" > < img src = "https://travis-ci.org/mixer/etcd3.svg?branch=master" alt = "Build Status" > < / a > < / h1 >
2017-04-15 00:14:28 +03:00
< p > etcd3 aims to be (with its first stable release) a high-quality, production-ready client for the Protocol Buffer-based etcdv3 API. It includes load balancing, reconnections, high-level query builders and lease management, mocking, and is type-safe for TypeScript consumers.< / p >
< h3 id = "quickstart" > Quickstart< / h3 >
< p > Install via:< / p >
< pre > < code > npm < span class = "hljs-keyword" > install< / span > < span class = "hljs-comment" > --save etcd3< / span >
< / code > < / pre > < p > Start CRUD-ing!< / p >
< pre > < code class = "lang-js" > < span class = "hljs-keyword" > const< / span > { Etcd3 } = < span class = "hljs-built_in" > require< / span > (< span class = "hljs-string" > 'etcd3'< / span > );
< span class = "hljs-keyword" > const< / span > client = < span class = "hljs-keyword" > new< / span > Etcd3();
client.put(< span class = "hljs-string" > 'foo'< / span > ).value(< span class = "hljs-string" > 'bar'< / span > )
.then(< span class = "hljs-function" > < span class = "hljs-params" > ()< / span > => < / span > client.get(< span class = "hljs-string" > 'foo'< / span > ).string())
.then(< span class = "hljs-function" > < span class = "hljs-params" > value< / span > => < / span > < span class = "hljs-built_in" > console< / span > .log(< span class = "hljs-string" > 'foo was:'< / span > , value))
.then(< span class = "hljs-function" > < span class = "hljs-params" > ()< / span > => < / span > client.getAll().prefix(< span class = "hljs-string" > 'f'< / span > ).strings())
.then(< span class = "hljs-function" > < span class = "hljs-params" > keys< / span > => < / span > < span class = "hljs-built_in" > console< / span > .log(< span class = "hljs-string" > 'all our keys starting with "f":'< / span > , keys))
.then(< span class = "hljs-function" > < span class = "hljs-params" > ()< / span > => < / span > client.delete().all());
< / code > < / pre >
2017-04-17 19:00:55 +03:00
< h3 id = "api-documentation" > API Documentation< / h3 >
2017-06-03 19:26:50 +03:00
< p > Our < a href = "https://mixer.github.io/etcd3/classes/index_.etcd3.html" > TypeDoc docs are available here< / a > .< / p >
< p > Our < a href = "https://github.com/mixer/etcd3/blob/master/test/kv.test.ts" > test cases< / a > are also quite readable.< / p >
2017-04-15 00:14:28 +03:00
< h3 id = "contributing" > Contributing< / h3 >
< p > Running tests for this module requires running an etcd3 server locally. The tests try to use the default port initially, and you can configure this by setting the < code > ETCD_ADDR< / code > environment variable, like < code > export ETCD_ADDR=localhost:12345< / code > .< / p >
< / div >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = "globals " >
< a href = "globals.html" > < em > Globals< / em > < / a >
< / li >
2017-06-03 19:39:28 +03:00
< li class = " tsd-kind-external-module" >
< a href = "modules/auth_.html" > "auth"< / a >
< / li >
2017-04-15 00:14:28 +03:00
< li class = " tsd-kind-external-module" >
< a href = "modules/backoff_backoff_.html" > "backoff/backoff"< / a >
< / li >
< li class = " tsd-kind-external-module" >
< a href = "modules/backoff_exponential_.html" > "backoff/exponential"< / a >
< / li >
2017-04-17 19:00:55 +03:00
< li class = " tsd-kind-external-module" >
< a href = "modules/builder_.html" > "builder"< / a >
< / li >
2017-04-15 00:14:28 +03:00
< li class = " tsd-kind-external-module" >
< a href = "modules/connection_pool_.html" > "connection-< wbr > pool"< / a >
< / li >
< li class = " tsd-kind-external-module" >
< a href = "modules/errors_.html" > "errors"< / a >
< / li >
< li class = " tsd-kind-external-module" >
< a href = "modules/index_.html" > "index"< / a >
< / li >
< li class = " tsd-kind-external-module" >
2017-04-17 19:00:55 +03:00
< a href = "modules/lease_.html" > "lease"< / a >
2017-04-15 00:14:28 +03:00
< / li >
< li class = " tsd-kind-external-module" >
2017-04-17 19:00:55 +03:00
< a href = "modules/lock_.html" > "lock"< / a >
2017-04-15 00:14:28 +03:00
< / li >
< li class = " tsd-kind-external-module" >
< a href = "modules/options_.html" > "options"< / a >
< / li >
2017-06-03 19:39:28 +03:00
< li class = " tsd-kind-external-module" >
< a href = "modules/range_.html" > "range"< / a >
< / li >
2017-04-15 00:14:28 +03:00
< li class = " tsd-kind-external-module" >
< a href = "modules/rpc_.html" > "rpc"< / a >
< / li >
< li class = " tsd-kind-external-module" >
< a href = "modules/shared_pool_.html" > "shared-< wbr > pool"< / a >
< / li >
< li class = " tsd-kind-external-module" >
< a href = "modules/util_.html" > "util"< / a >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< ul class = "before-current" >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > Legend< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-module" > < span class = "tsd-kind-icon" > Module< / span > < / li >
< li class = "tsd-kind-object-literal" > < span class = "tsd-kind-icon" > Object literal< / span > < / li >
< li class = "tsd-kind-variable" > < span class = "tsd-kind-icon" > Variable< / span > < / li >
< li class = "tsd-kind-function" > < span class = "tsd-kind-icon" > Function< / span > < / li >
< li class = "tsd-kind-function tsd-has-type-parameter" > < span class = "tsd-kind-icon" > Function with type parameter< / span > < / li >
< li class = "tsd-kind-index-signature" > < span class = "tsd-kind-icon" > Index signature< / span > < / li >
< li class = "tsd-kind-type-alias" > < span class = "tsd-kind-icon" > Type alias< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-enum" > < span class = "tsd-kind-icon" > Enumeration< / span > < / li >
< li class = "tsd-kind-enum-member" > < span class = "tsd-kind-icon" > Enumeration member< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-enum" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-enum" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-interface" > < span class = "tsd-kind-icon" > Interface< / span > < / li >
< li class = "tsd-kind-interface tsd-has-type-parameter" > < span class = "tsd-kind-icon" > Interface with type parameter< / span > < / li >
< li class = "tsd-kind-constructor tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< li class = "tsd-kind-index-signature tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Index signature< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-class" > < span class = "tsd-kind-icon" > Class< / span > < / li >
< li class = "tsd-kind-class tsd-has-type-parameter" > < span class = "tsd-kind-icon" > Class with type parameter< / span > < / li >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< li class = "tsd-kind-accessor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Accessor< / span > < / li >
< li class = "tsd-kind-index-signature tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Index signature< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited method< / span > < / li >
< li class = "tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited accessor< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-protected" > < span class = "tsd-kind-icon" > Protected property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-protected" > < span class = "tsd-kind-icon" > Protected method< / span > < / li >
< li class = "tsd-kind-accessor tsd-parent-kind-class tsd-is-protected" > < span class = "tsd-kind-icon" > Protected accessor< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-private" > < span class = "tsd-kind-icon" > Private property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-private" > < span class = "tsd-kind-icon" > Private method< / span > < / li >
< li class = "tsd-kind-accessor tsd-parent-kind-class tsd-is-private" > < span class = "tsd-kind-icon" > Private accessor< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static property< / span > < / li >
< li class = "tsd-kind-call-signature tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static method< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > Generated using < a href = "http://typedoc.org/" target = "_blank" > TypeDoc< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "assets/js/main.js" > < / script >
< script > if ( location . protocol == 'file:' ) document . write ( '<script src="assets/js/search.js"><' + '/script>' ) ; < / script >
< / body >
< / html >
