Options
All
  • Public
  • Public/Protected
  • All
Menu

params for init envoy context

Hierarchy

Index

Properties

Object

Object: ObjectConstructor

Provides functionality common to all JavaScript objects.

constructor

constructor: Function

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

Optional directMode

directMode: undefined | false | true

For dev or test environment, we usually don't have Envoy running. By setting directMode = true will make all the traffic being sent directly. If you set directMode to true, envoyManagedHosts will be ignored and set to an empty set.

Optional envoyEgressAddr

envoyEgressAddr: undefined | string

optional egress address information if not specified, it will be read from meta / environment variable ENVOY_EGRESS_ADDR / default value: 127.0.0.1 (one after another)

Optional envoyEgressPort

envoyEgressPort: undefined | number

optional egress port information if not specified, it will be read from meta / environment variable ENVOY_EGRESS_PORT / default value: 12345 (one after another)

Optional envoyManagedHosts

envoyManagedHosts: Set<string>

For easier migrate service to envoy step by step, we can route traffic to envoy for those service migrated. Fill this set for the migrated service. This field is default to undefined which means all traffic will be route to envoy. If this field is set to undefined, this library will also try to read it from x-tubi-envoy-managed-host. You can set in envoy config, like this:

request_headers_to_add:
- key: x-tubi-envoy-managed-host
  value: hostname:12345
- key: x-tubi-envoy-managed-host
  value: foo.bar:8080

If you set this to be an empty set, then no traffic will be route to envoy.

meta

meta: HttpHeader | Metadata

you can either give HTTP header for grpc.Metadata, it will be converted accordingly.

Methods

hasOwnProperty

  • hasOwnProperty(v: PropertyKey): boolean
  • Determines whether an object has a property with the specified name.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

isPrototypeOf

  • isPrototypeOf(v: Object): boolean
  • Determines whether an object exists in another object's prototype chain.

    Parameters

    • v: Object

      Another object whose prototype chain is to be checked.

    Returns boolean

propertyIsEnumerable

  • propertyIsEnumerable(v: PropertyKey): boolean
  • Determines whether a specified property is enumerable.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

toLocaleString

  • toLocaleString(): string
  • Returns a date converted to a string using the current locale.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an object.

    Returns string

valueOf

  • Returns the primitive value of the specified object.

    Returns Object

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method
  • Property
  • Inherited property

Generated using TypeDoc