Class

io.scalajs.npm.kafkanode

ConsumerOptions

Related Doc: package kafkanode

Permalink

class ConsumerOptions extends Object

Consumer Options

Annotations
@RawJSType() @ScalaJSDefined()
Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsumerOptions
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ConsumerOptions(groupId: UndefOr[String] = js.undefined, autoCommit: UndefOr[Boolean] = js.undefined, autoCommitIntervalMs: UndefOr[Int] = js.undefined, fetchMaxWaitMs: UndefOr[Int] = js.undefined, fetchMinBytes: UndefOr[Int] = js.undefined, fetchMaxBytes: UndefOr[Int] = js.undefined, fromOffset: UndefOr[Long] = js.undefined, encoding: UndefOr[String] = js.undefined)

    Permalink

    groupId

    consumer group id, deafult kafka-node-group

    autoCommit

    Auto commit config

    autoCommitIntervalMs

    The max wait time is the maximum amount of time in milliseconds to block waiting if insufficient data is available at the time the request is issued, default 100ms

    fetchMaxWaitMs

    This is the minimum number of bytes of messages that must be available to give a response, default 1 byte.

    fetchMinBytes

    The maximum bytes to include in the message set for this partition. This helps bound the size of the response.

    fetchMaxBytes

    If set true, consumer will fetch message from the given offset in the payloads.

    fromOffset

    The starting offset

    encoding

    If set to 'buffer', values will be returned as raw buffer objects.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. var autoCommit: UndefOr[Boolean]

    Permalink

    Auto commit config

  6. var autoCommitIntervalMs: UndefOr[Int]

    Permalink

    The max wait time is the maximum amount of time in milliseconds to block waiting if insufficient data is available at the time the request is issued, default 100ms

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. var encoding: UndefOr[String]

    Permalink

    If set to 'buffer', values will be returned as raw buffer objects.

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. var fetchMaxBytes: UndefOr[Int]

    Permalink

    If set true, consumer will fetch message from the given offset in the payloads.

  12. var fetchMaxWaitMs: UndefOr[Int]

    Permalink

    This is the minimum number of bytes of messages that must be available to give a response, default 1 byte.

  13. var fetchMinBytes: UndefOr[Int]

    Permalink

    The maximum bytes to include in the message set for this partition.

    The maximum bytes to include in the message set for this partition. This helps bound the size of the response.

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. var fromOffset: UndefOr[Long]

    Permalink

    The starting offset

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. var groupId: UndefOr[String]

    Permalink

    consumer group id, deafult kafka-node-group

  18. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  27. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  28. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  29. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  30. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped