mirror of
https://github.com/grpc/grpc-node.git
synced 2025-12-08 18:23:54 +00:00
Add grpc-js-xds README
This commit is contained in:
parent
c86f08c770
commit
e05b74b631
24
packages/grpc-js-xds/README.md
Normal file
24
packages/grpc-js-xds/README.md
Normal file
@ -0,0 +1,24 @@
|
||||
# @grpc/grpc-js xDS plugin
|
||||
|
||||
This package provides support for the `xds://` URL scheme to the `@grpc/grpc-js` library. The latest version of this package is compatible with `@grpc/grpc-js` version 1.2.x.
|
||||
|
||||
## Installation
|
||||
|
||||
```
|
||||
npm install @grpc/grpc-js-xds
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import * as grpcJsXds from '@grpc/grpc-js-xds';
|
||||
grpcJsXds.register();
|
||||
|
||||
// ...get a @grpc/grpc-js Client class as usual
|
||||
|
||||
const client = new MyServiceClient('xds:///example.com:123');
|
||||
```
|
||||
|
||||
## Supported Features
|
||||
|
||||
- [xDS-Based Global Load Balancing](https://github.com/grpc/proposal/blob/master/A27-xds-global-load-balancing.md)
|
||||
Loading…
x
Reference in New Issue
Block a user