• Public
  • Public/Protected
  • All

Top-level Fluvio Client options;

These options are unstable and may be categorized into more specific interfaces; For now, this is the global options used by the entirety of the fluvio client;

It is best practice to use explicit arguments directly with the class methods If an option or argument does not exist that is optional, a default value will be used.


  • Options



Optional encryption

encryption: undefined | Plaintext | Ssl

Optional env

env: undefined | EnvVar[]

Optional host

host: undefined | string

Optional id

id: undefined | number

Optional ignoreRackAssignment

ignoreRackAssignment: undefined | boolean

Optional ingress

ingress: undefined | IngressAddr[]

Optional maps

maps: undefined | PartitionMap[]

Optional minId

minId: undefined | number

Optional offsetFrom

offsetFrom: undefined | string

Optional offsetIndex

offsetIndex: undefined | number

Optional partition

partition: undefined | number

Optional partitions

partitions: undefined | number

Optional port

port: undefined | number

Optional rack

rack: undefined | string

Optional replicas

replicas: undefined | number

Optional replication

replication: undefined | ReplicationConfig

Optional replicationFactor

replicationFactor: undefined | number

Optional storage

storage: undefined | StorageConfig

Optional topic

topic: undefined | string


  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Private property
  • Private method
  • Static method

Generated using TypeDoc