From 35afdad7c9cc9b6bb87f13193061707aa9bbff2e Mon Sep 17 00:00:00 2001 From: Fluvio Authors Date: Tue, 11 Jun 2024 00:11:32 +0000 Subject: [PATCH] Updated Fluvio Node.js client docs --- docs/classes/CustomSpuSpec.html | 4 +- docs/classes/FluvioAdmin.html | 48 +++++++++---------- docs/classes/Offset.html | 4 +- docs/classes/PartitionConsumer.html | 12 ++--- docs/classes/SpuConfig.html | 4 +- docs/classes/SpuGroupSpec.html | 4 +- docs/classes/TopicProducer.html | 18 +++---- docs/classes/TopicSpec.html | 4 +- docs/classes/default.html | 16 +++---- docs/enums/Encryption.html | 4 +- docs/enums/ErrorCode.html | 4 +- docs/enums/OffsetFrom.html | 4 +- docs/enums/SmartModuleType.html | 4 +- docs/functions/arrayBufferToString.html | 2 +- docs/functions/stringToArrayBuffer.html | 2 +- docs/interfaces/Batch.html | 4 +- docs/interfaces/BatchHeader.html | 4 +- docs/interfaces/ConsumerConfig.html | 8 ++-- docs/interfaces/DefaultRecord.html | 4 +- docs/interfaces/Endpoint.html | 4 +- docs/interfaces/EnvVar.html | 4 +- .../FetchablePartitionResponse.html | 6 +-- docs/interfaces/FluvioClient.html | 4 +- docs/interfaces/IngressAddr.html | 4 +- docs/interfaces/IngressPort.html | 4 +- docs/interfaces/Options.html | 4 +- docs/interfaces/PartitionMap.html | 4 +- docs/interfaces/PartitionMaps.html | 4 +- docs/interfaces/PartitionSpec.html | 4 +- docs/interfaces/PartitionSpecMetadata.html | 4 +- docs/interfaces/PartitionSpecStatus.html | 4 +- docs/interfaces/Record.html | 12 ++--- docs/interfaces/RecordSet.html | 4 +- docs/interfaces/ReplicaStatus.html | 4 +- docs/interfaces/ReplicationConfig.html | 4 +- docs/interfaces/StorageConfig.html | 4 +- docs/interfaces/Topic.html | 4 +- docs/interfaces/TopicReplicaParam.html | 4 +- docs/types/KeyValue.html | 2 +- docs/variables/DEFAULT_HOST.html | 2 +- docs/variables/DEFAULT_ID.html | 2 +- .../DEFAULT_IGNORE_RACK_ASSIGNMENT.html | 2 +- docs/variables/DEFAULT_MIN_ID.html | 2 +- docs/variables/DEFAULT_OFFSET.html | 2 +- docs/variables/DEFAULT_OFFSET_FROM.html | 2 +- docs/variables/DEFAULT_PARTITIONS.html | 2 +- docs/variables/DEFAULT_PORT.html | 2 +- docs/variables/DEFAULT_PRIVATE_PORT.html | 2 +- docs/variables/DEFAULT_PUBLIC_PORT.html | 2 +- docs/variables/DEFAULT_REPLICAS.html | 2 +- .../variables/DEFAULT_REPLICATION_FACTOR.html | 2 +- docs/variables/DEFAULT_TOPIC.html | 2 +- docs/variables/PartitionConsumerJS.html | 2 +- 53 files changed, 135 insertions(+), 135 deletions(-) diff --git a/docs/classes/CustomSpuSpec.html b/docs/classes/CustomSpuSpec.html index a5780dca..3d8855a1 100644 --- a/docs/classes/CustomSpuSpec.html +++ b/docs/classes/CustomSpuSpec.html @@ -1,6 +1,6 @@ -CustomSpuSpec | @fluvio/client

Class CustomSpuSpec

Constructors

constructor +CustomSpuSpec | @fluvio/client

Class CustomSpuSpec

Constructors

constructor

Properties

id privateEndpoint publicEndpoint rack? -

Constructors

constructor

Properties

id

id: number

privateEndpoint

privateEndpoint: Endpoint

publicEndpoint

publicEndpoint: IngressPort

Optional rack

rack?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

id

id: number

privateEndpoint

privateEndpoint: Endpoint

publicEndpoint

publicEndpoint: IngressPort

Optional rack

rack?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/FluvioAdmin.html b/docs/classes/FluvioAdmin.html index bee0eb60..c2c388c2 100644 --- a/docs/classes/FluvioAdmin.html +++ b/docs/classes/FluvioAdmin.html @@ -9,7 +9,7 @@

Example Construction

const fluvio = new Fluvio({ host, port })

await fluvio.connect();

const admin = await fluvio.admin();

Errors

Creating an admin client will fail if you do not have admin authorization in the connected custer.

-

Constructors

constructor +

Constructors

constructor

Properties

inner options?

Methods

createCustomSpu @@ -28,54 +28,54 @@ along with top-level Fluvio client options, if any.

Parameters

  • inner: FluvioAdmin

    The native FluvioAdmin module, must be the value returned from await new Fluvio().admin();

  • Optional options: Partial<Options>

    Optional values inherited from top-level options;

    -

Returns FluvioAdmin

Properties

Private inner

inner: FluvioAdmin

Optional options

options?: Partial<Options>

Methods

createCustomSpu

  • createCustomSpu(name, spec?): Promise<void>

  • Create a new custom Streaming Processing Unit (SPU)

    +

Returns FluvioAdmin

Properties

Private inner

inner: FluvioAdmin

Optional options

options?: Partial<Options>

Methods

createCustomSpu

  • createCustomSpu(name, spec?): Promise<void>

  • Create a new custom Streaming Processing Unit (SPU)

    Parameters

    • name: string

      Name of the custom spu;

    • Optional spec: CustomSpuSpec

      Pass in a custom spec or use a default based on top-level options;

      -

    Returns Promise<void>

  • createCustomSpu(name, spec?): Promise<void>

  • Create a new custom Streaming Processing Unit (SPU)

    +

Returns Promise<void>

  • createCustomSpu(name, spec?): Promise<void>

  • Create a new custom Streaming Processing Unit (SPU)

    Parameters

    • name: string

      Name of the custom spu;

    • Optional spec: CustomSpuSpec

      Pass in a custom spec or use a default based on top-level options;

      -

    Returns Promise<void>

    • createManagedSpu

    • createManagedSpu(name, spec?): Promise<void>

    • Create a new managed Streaming Processing Unit (SPU)

      +

    Returns Promise<void>

    createManagedSpu

    • createManagedSpu(name, spec?): Promise<void>

    • Create a new managed Streaming Processing Unit (SPU)

      Parameters

      • name: string

        name of the managed spu group

      • Optional spec: SpuGroupSpec

        Optional specification for the SpuGroup. If no spec is provided, default settings will be used.

        -

      Returns Promise<void>

    • createManagedSpu(name, spec?): Promise<void>

    • Create a new managed Streaming Processing Unit (SPU)

      +

    Returns Promise<void>

  • createManagedSpu(name, spec?): Promise<void>

  • Create a new managed Streaming Processing Unit (SPU)

    Parameters

    • name: string

      name of the managed spu group

    • Optional spec: SpuGroupSpec

      Optional specification for the SpuGroup. If no spec is provided, default settings will be used.

      -

    Returns Promise<void>

    • createTopic

    • createTopic(topic, spec?): Promise<string>

    • Create a new topic with an optional topic specification;

      +

    Returns Promise<void>

    createTopic

    • createTopic(topic, spec?): Promise<string>

    • Create a new topic with an optional topic specification;

      Parameters

      Returns Promise<string>

    • createTopic(topic, spec?): Promise<string>

    • Create a new topic with an optional topic specification;

      +

    Returns Promise<string>

  • createTopic(topic, spec?): Promise<string>

  • Create a new topic with an optional topic specification;

    Parameters

    Returns Promise<string>

    • deleteCustomSpu

    • deleteCustomSpu(key): Promise<void>

    • Delete a custom SPU using either a string or number;

      +

    Returns Promise<string>

    deleteCustomSpu

    • deleteCustomSpu(key): Promise<void>

    • Delete a custom SPU using either a string or number;

      Parameters

      • key: string | number

        SPU key to target for deletion;

        -

      Returns Promise<void>

    • deleteCustomSpu(key): Promise<void>

    • Delete a custom SPU using either a string or number;

      +

    Returns Promise<void>

  • deleteCustomSpu(key): Promise<void>

  • Delete a custom SPU using either a string or number;

    Parameters

    • key: string | number

      SPU key to target for deletion;

      -

    Returns Promise<void>

    • deleteManagedSpu

    • deleteManagedSpu(name): Promise<void>

    • Delete a managed SPU by name

      +

    Returns Promise<void>

    deleteManagedSpu

    • deleteManagedSpu(name): Promise<void>

    • Delete a managed SPU by name

      Parameters

      • name: string

        Name of the managed SPU to delete;

        -

      Returns Promise<void>

    • deleteManagedSpu(name): Promise<void>

    • Delete a managed SPU by name

      +

    Returns Promise<void>

  • deleteManagedSpu(name): Promise<void>

  • Delete a managed SPU by name

    Parameters

    • name: string

      Name of the managed SPU to delete;

      -

    Returns Promise<void>

    • deleteTopic

    • deleteTopic(topic): Promise<string>

    • Delete a topic by name

      +

    Returns Promise<void>

    deleteTopic

    • deleteTopic(topic): Promise<string>

    • Delete a topic by name

      Parameters

      • topic: string

        Name of the topic to delete

        -

      Returns Promise<string>

    • deleteTopic(topic): Promise<string>

    • Delete a topic by name

      +

    Returns Promise<string>

  • deleteTopic(topic): Promise<string>

  • Delete a topic by name

    Parameters

    • topic: string

      Name of the topic to delete

      -

    Returns Promise<string>

    • findPartition

    Returns Promise<string>

    findPartition

    Returns Promise<PartitionSpecMetadata>

  • findPartition(topic): Promise<PartitionSpecMetadata>

  • Find a partition by topic name;

    Parameters

    • topic: string

      topic name to search partition by

      -

    Returns Promise<PartitionSpecMetadata>

    • findTopic

    • findTopic(topic): Promise<Topic>

    • Find a topic by name

      +

    Returns Promise<PartitionSpecMetadata>

    findTopic

    • findTopic(topic): Promise<Topic>

    • Find a topic by name

      Parameters

      • topic: string

        Name of the topic to find;

        -

      Returns Promise<Topic>

    • findTopic(topic): Promise<Topic>

    • Find a topic by name

      +

    Returns Promise<Topic>

  • findTopic(topic): Promise<Topic>

  • Find a topic by name

    Parameters

    • topic: string

      Name of the topic to find;

      -

    Returns Promise<Topic>

    • listPartitions

    • listPartitions(): Promise<string>

    • List partitions

      -

      Returns Promise<string>

    • listPartitions(): Promise<string>

    • List partitions

      -

      Returns Promise<string>

    listSpu

    • listSpu(): Promise<string>

    • List SPUs +

    Returns Promise<Topic>

    listPartitions

    • listPartitions(): Promise<string>

    • List partitions

      +

      Returns Promise<string>

    • listPartitions(): Promise<string>

    • List partitions

      +

      Returns Promise<string>

    listSpu

    • listSpu(): Promise<string>

    • List SPUs TODO: convert stringified json to structured types;

      -

      Returns Promise<string>

    • listSpu(): Promise<string>

    • List SPUs +

      Returns Promise<string>

    • listSpu(): Promise<string>

    • List SPUs TODO: convert stringified json to structured types;

      -

      Returns Promise<string>

    listTopic

    • listTopic(): Promise<string>

    • List topics

      -

      Returns Promise<string>

    • listTopic(): Promise<string>

    • List topics

      -

      Returns Promise<string>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<string>

    listTopic

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Offset.html b/docs/classes/Offset.html index 92685d42..5e4a31a8 100644 --- a/docs/classes/Offset.html +++ b/docs/classes/Offset.html @@ -1,6 +1,6 @@ -Offset | @fluvio/client

    Class Offset

    Constructors

    constructor +Offset | @fluvio/client

    Class Offset

    Constructors

    constructor

    Properties

    from? index

    Methods

    FromBeginning FromEnd -

    Constructors

    constructor

    Properties

    Optional from

    from?: string

    index

    index: number

    Methods

    Static FromBeginning

    Static FromEnd

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional from

    from?: string

    index

    index: number

    Methods

    Static FromBeginning

    Static FromEnd

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/PartitionConsumer.html b/docs/classes/PartitionConsumer.html index e7d36d24..8ed994e2 100644 --- a/docs/classes/PartitionConsumer.html +++ b/docs/classes/PartitionConsumer.html @@ -12,7 +12,7 @@

    The inner object is a private object that is the native module created by the top-level Fluvio client.

    This class is not intended to be constructed manually.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    inner

    Methods

    createStream endStream @@ -24,24 +24,24 @@ method used by the Fluvio class to pass in a native object, along with top-level Fluvio client options, if any.

    Parameters

    • inner: PartitionConsumer

      The native node module created by new Fluvio().connect().partitionConsumer()

      -

    Returns PartitionConsumer

    Properties

    Private inner

    inner: any

    Methods

    createStream

    Returns PartitionConsumer

    Properties

    Private inner

    inner: any

    Methods

    createStream

    • createStream(offset): Promise<AsyncIterable<Record>>

    • This returns an AsyncIterable. Usage:

      const stream = await consumer.getIterator(Offset.FromBeginning())
      for await (const next of stream) {
          console.log(next)
      }
      -

      Parameters

      Returns Promise<AsyncIterable<Record>>

    • createStream(offset): Promise<AsyncIterable<Record>>

    • This returns an AsyncIterable. +

      Parameters

      Returns Promise<AsyncIterable<Record>>

    • createStream(offset): Promise<AsyncIterable<Record>>

    • This returns an AsyncIterable. Usage:

      const stream = await consumer.getIterator(Offset.FromBeginning())
      for await (const next of stream) {
          console.log(next)
      }
      -

      Parameters

      Returns Promise<AsyncIterable<Record>>

    endStream

    • endStream(): Promise<void>

    • Returns Promise<void>

    fetch

    endStream

    • endStream(): Promise<void>

    • Returns Promise<void>

    fetch

    • fetch(offset?): Promise<FetchablePartitionResponse>

    • Fetches events from a particular offset in the consumer's partition

      A "fetch" is one of the two ways to consume events in Fluvio. It is a batch request for records from a particular offset in the partition.

      You specify the position of records to retrieve using an Offset, and receive the events as a list of records.

      Parameters

      • Optional offset: Offset

        Describes the location of an event stored in a Fluvio partition

        -

      Returns Promise<FetchablePartitionResponse>

    • fetch(offset?): Promise<FetchablePartitionResponse>

    • Fetches events from a particular offset in the consumer's partition

      +

    Returns Promise<FetchablePartitionResponse>

  • fetch(offset?): Promise<FetchablePartitionResponse>

  • Fetches events from a particular offset in the consumer's partition

    A "fetch" is one of the two ways to consume events in Fluvio. It is a batch request for records from a particular offset in the partition.

    You specify the position of records to retrieve using an Offset, and receive the events as a list of records.

    Parameters

    • Optional offset: Offset

      Describes the location of an event stored in a Fluvio partition

      -

    Returns Promise<FetchablePartitionResponse>

    • stream

    • stream(offset, cb): Promise<void>

    • Parameters

      • offset: Offset
      • cb: ((record) => void)
          • (record): void

          • Parameters

            Returns void

      Returns Promise<void>

    • stream(offset, cb): Promise<void>

    • Parameters

      • offset: Offset
      • cb: ((record) => void)
          • (record): void

          • Parameters

            Returns void

      Returns Promise<void>

    streamWithConfig

    Static create

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<FetchablePartitionResponse>

    stream

    streamWithConfig

    Static create

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/SpuConfig.html b/docs/classes/SpuConfig.html index 658ae064..aba3a7cb 100644 --- a/docs/classes/SpuConfig.html +++ b/docs/classes/SpuConfig.html @@ -1,6 +1,6 @@ -SpuConfig | @fluvio/client

    Class SpuConfig

    Constructors

    constructor +SpuConfig | @fluvio/client

    Class SpuConfig

    Constructors

    constructor

    Properties

    env rack? replication? storage? -

    Constructors

    constructor

    Properties

    env

    env: EnvVar[]

    Optional rack

    rack?: string

    Optional replication

    replication?: ReplicationConfig

    Optional storage

    storage?: StorageConfig

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    env

    env: EnvVar[]

    Optional rack

    rack?: string

    Optional replication

    replication?: ReplicationConfig

    Optional storage

    storage?: StorageConfig

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/SpuGroupSpec.html b/docs/classes/SpuGroupSpec.html index 19ccb890..6e6193fd 100644 --- a/docs/classes/SpuGroupSpec.html +++ b/docs/classes/SpuGroupSpec.html @@ -1,5 +1,5 @@ -SpuGroupSpec | @fluvio/client

    Class SpuGroupSpec

    Constructors

    constructor +SpuGroupSpec | @fluvio/client

    Class SpuGroupSpec

    Constructors

    constructor

    Properties

    minId replicas spuConfig -

    Constructors

    constructor

    Properties

    minId

    minId: number

    replicas

    replicas: number

    spuConfig

    spuConfig: SpuConfig

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    minId

    minId: number

    replicas

    replicas: number

    spuConfig

    spuConfig: SpuConfig

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/TopicProducer.html b/docs/classes/TopicProducer.html index 4a63d787..ab0f4400 100644 --- a/docs/classes/TopicProducer.html +++ b/docs/classes/TopicProducer.html @@ -10,7 +10,7 @@

    The inner object is a private object that is the native module created by the top-level Fluvio client.

    This class is not intended to be constructed manually.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    inner

    Methods

    flush send @@ -22,20 +22,20 @@ method used by the Fluvio class to pass in a native object, along with top-level Fluvio client options, if any.

    Parameters

    • inner: TopicProducer

      The native node module created by await (new Fluvio().connect()).topicProducer()

      -

    Returns TopicProducer

    Properties

    Private inner

    inner: TopicProducer

    Methods

    flush

    • flush(): Promise<void>

    • Returns Promise<void>

    • flush(): Promise<void>

    • Returns Promise<void>

    send

    • send(key, value): Promise<void>

    • Sends a key-value event to this producer's topic

      +

    Returns TopicProducer

    Properties

    Private inner

    inner: TopicProducer

    Methods

    flush

    • flush(): Promise<void>

    • Returns Promise<void>

    • flush(): Promise<void>

    • Returns Promise<void>

    send

    • send(key, value): Promise<void>

    • Sends a key-value event to this producer's topic

      Parameters

      • key: ProducerItem

        The Key data of the record to send

      • value: ProducerItem

        The Value data of the record to send

        -

      Returns Promise<void>

    • send(key, value): Promise<void>

    • Sends a key-value event to this producer's topic

      +

    Returns Promise<void>

  • send(key, value): Promise<void>

  • Sends a key-value event to this producer's topic

    Parameters

    • key: string | ArrayBuffer

      The Key data of the record to send

    • value: string | ArrayBuffer

      The Value data of the record to send

      -

    Returns Promise<void>

    • sendAll

    • sendAll(records): Promise<void>

    • Sends a list of key-value elements to this producer's topic

      -

      Parameters

      Returns Promise<void>

    • sendAll(elements): Promise<void>

    • Sends a list of key-value elements to this producer's topic

      -

      Parameters

      Returns Promise<void>

    sendRecord

    • sendRecord(data, partition): Promise<void>

    • Sends an event to a specific partition within this producer's topic

      +

    Returns Promise<void>

    sendAll

    • sendAll(records): Promise<void>

    • Sends a list of key-value elements to this producer's topic

      +

      Parameters

      Returns Promise<void>

    • sendAll(elements): Promise<void>

    • Sends a list of key-value elements to this producer's topic

      +

      Parameters

      Returns Promise<void>

    sendRecord

    • sendRecord(data, partition): Promise<void>

    • Sends an event to a specific partition within this producer's topic

      Parameters

      • data: string
      • partition: number

        The partition that this record will be sent to

        -

      Returns Promise<void>

    • sendRecord(value, partition): Promise<void>

    • Sends an event to a specific partition within this producer's topic

      +

    Returns Promise<void>

  • sendRecord(value, partition): Promise<void>

  • Sends an event to a specific partition within this producer's topic

    Parameters

    • value: string

      Buffered data to send to the Fluvio partition

    • partition: number

      The partition that this record will be sent to

      -

    Returns Promise<void>

    • Static create

    • create(inner): TopicProducer

    • Factory method for creating a new topic Producer; This method is used by the +

    Returns Promise<void>

    Static create

    • create(inner): TopicProducer

    • Factory method for creating a new topic Producer; This method is used by the Fluvio class. It is not meant to be called directly;

      Parameters

      • inner: TopicProducer

        The native node module created by await (new Fluvio().connect()).topicProducer()

        -

      Returns TopicProducer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns TopicProducer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/TopicSpec.html b/docs/classes/TopicSpec.html index a8f70199..afca4d82 100644 --- a/docs/classes/TopicSpec.html +++ b/docs/classes/TopicSpec.html @@ -1,3 +1,3 @@ -TopicSpec | @fluvio/client

    Class TopicSpec

    Constructors

    constructor +TopicSpec | @fluvio/client

    Class TopicSpec

    Constructors

    constructor

    Properties

    opts -

    Constructors

    constructor

    Properties

    opts

    opts: PartitionMaps | TopicReplicaParam

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    opts

    opts: PartitionMaps | TopicReplicaParam

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/default.html b/docs/classes/default.html index 161ae347..6d78ee49 100644 --- a/docs/classes/default.html +++ b/docs/classes/default.html @@ -5,7 +5,7 @@

    Core module is generated from node-bindgen. This TypeScript wrapper provides type definitions and generates the JavaScript client.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    client? inner options @@ -17,24 +17,24 @@ connect

    Constructors

    constructor

    • new default(options?): default

    • Parameters

      • Optional options: Options

        Options provides top-level access to common configurable values used by the Fluvio client.

        -

      Returns default

    Properties

    Private Optional client

    client?: FluvioClient

    Private inner

    inner: any

    Private options

    options: Options

    Methods

    admin

    Private checkConnection

    • checkConnection(): void

    • Check to ensure this.client has been set. This method is used internally to check +

    Returns default

    Properties

    Private Optional client

    client?: FluvioClient

    Private inner

    inner: any

    Private options

    options: Options

    Methods

    admin

    Private checkConnection

    • checkConnection(): void

    • Check to ensure this.client has been set. This method is used internally to check the connection status of the client before calling a method using the internal client.

      -

      Returns void

    connect

    • connect(options?): Promise<FluvioClient>

    • Parameters

      • Optional options: Partial<Options>

        Optionally pass in connection host options (e.g. { host: '' }) +

        Returns void

    connect

    • connect(options?): Promise<FluvioClient>

    • Parameters

      • Optional options: Partial<Options>

        Optionally pass in connection host options (e.g. { host: '' }) uses the partial Options type; This does not override the default options, only replaces default options in this case;

        -

      Returns Promise<FluvioClient>

    partitionConsumer

    • partitionConsumer(topic, partition): Promise<PartitionConsumer>

    • Creates a new PartitionConsumer for the given topic and partition

      +

    Returns Promise<FluvioClient>

    partitionConsumer

    • partitionConsumer(topic, partition): Promise<PartitionConsumer>

    • Creates a new PartitionConsumer for the given topic and partition

      Currently, consumers are scoped to both a specific Fluvio topic and to a particular partition within that topic. That means that if you have a topic with multiple partitions, then in order to receive all of the events in all of the partitions, you will need to create one consumer per partition.

      Parameters

      • topic: string

        topic string

      • partition: number

        partition id

        -

      Returns Promise<PartitionConsumer>

    topicProducer

    • topicProducer(topic): Promise<TopicProducer>

    • Creates a new TopicProducer for the given topic name

      +

    Returns Promise<PartitionConsumer>

    topicProducer

    • topicProducer(topic): Promise<TopicProducer>

    • Creates a new TopicProducer for the given topic name

      Currently, producers are scoped to a specific Fluvio topic. That means when you send events via a producer, you must specify which partition each event should go to.

      Parameters

      • topic: string

        Name of the topic to create a producer for

        -

      Returns Promise<TopicProducer>

    Static connect

    • connect(options?): Promise<default>

    • Add static method to quickly create a connected client;

      +

    Returns Promise<TopicProducer>

    Static connect

    • connect(options?): Promise<default>

    • Add static method to quickly create a connected client;

      Parameters

      • Optional options: Options

        Fluvio options passed into new fluvio instance;

        -

      Returns Promise<default>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<default>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/Encryption.html b/docs/enums/Encryption.html index fbb13f18..623c7fec 100644 --- a/docs/enums/Encryption.html +++ b/docs/enums/Encryption.html @@ -1,3 +1,3 @@ -Encryption | @fluvio/client

    Enumeration Encryption

    Enumeration Members

    Plaintext +Encryption | @fluvio/client

    Enumeration Encryption

    Enumeration Members

    Plaintext Ssl -

    Enumeration Members

    Plaintext

    Plaintext: "Plaintext"

    Ssl

    Ssl: "Ssl"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Plaintext

    Plaintext: "Plaintext"

    Ssl

    Ssl: "Ssl"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/ErrorCode.html b/docs/enums/ErrorCode.html index a8551f7b..a87ac54b 100644 --- a/docs/enums/ErrorCode.html +++ b/docs/enums/ErrorCode.html @@ -1,4 +1,4 @@ -ErrorCode | @fluvio/client

    Enumeration ErrorCode

    Enumeration Members

    None +ErrorCode | @fluvio/client

    Enumeration ErrorCode

    Enumeration Members

    None NotLeaderForPartition OffsetOutOfRange PartitionNotLeader @@ -15,4 +15,4 @@ TopicNotFound TopicPendingInitialization UnknownServerError -

    Enumeration Members

    None

    None: 1

    NotLeaderForPartition

    NotLeaderForPartition: 3

    OffsetOutOfRange

    OffsetOutOfRange: 2

    PartitionNotLeader

    PartitionNotLeader: 16

    PartitionPendingInitialization

    PartitionPendingInitialization: 15

    SpuAlreadyExists

    SpuAlreadyExists: 9

    SpuError

    SpuError: 5

    SpuNotFound

    SpuNotFound: 8

    SpuOffline

    SpuOffline: 7

    SpuRegisterationFailed

    SpuRegisterationFailed: 6

    StorageError

    StorageError: 4

    TopicAlreadyExists

    TopicAlreadyExists: 12

    TopicError

    TopicError: 10

    TopicInvalidConfiguration

    TopicInvalidConfiguration: 14

    TopicNotFound

    TopicNotFound: 11

    TopicPendingInitialization

    TopicPendingInitialization: 13

    UnknownServerError

    UnknownServerError: 0

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    None

    None: 1

    NotLeaderForPartition

    NotLeaderForPartition: 3

    OffsetOutOfRange

    OffsetOutOfRange: 2

    PartitionNotLeader

    PartitionNotLeader: 16

    PartitionPendingInitialization

    PartitionPendingInitialization: 15

    SpuAlreadyExists

    SpuAlreadyExists: 9

    SpuError

    SpuError: 5

    SpuNotFound

    SpuNotFound: 8

    SpuOffline

    SpuOffline: 7

    SpuRegisterationFailed

    SpuRegisterationFailed: 6

    StorageError

    StorageError: 4

    TopicAlreadyExists

    TopicAlreadyExists: 12

    TopicError

    TopicError: 10

    TopicInvalidConfiguration

    TopicInvalidConfiguration: 14

    TopicNotFound

    TopicNotFound: 11

    TopicPendingInitialization

    TopicPendingInitialization: 13

    UnknownServerError

    UnknownServerError: 0

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/OffsetFrom.html b/docs/enums/OffsetFrom.html index 3ebba652..2484ddb7 100644 --- a/docs/enums/OffsetFrom.html +++ b/docs/enums/OffsetFrom.html @@ -1,3 +1,3 @@ -OffsetFrom | @fluvio/client

    Enumeration OffsetFrom

    Enumeration Members

    Beginning +OffsetFrom | @fluvio/client

    Enumeration OffsetFrom

    Enumeration Members

    Beginning End -

    Enumeration Members

    Beginning

    Beginning: "beginning"

    End

    End: "end"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Beginning

    Beginning: "beginning"

    End

    End: "end"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/SmartModuleType.html b/docs/enums/SmartModuleType.html index fe835768..8c830938 100644 --- a/docs/enums/SmartModuleType.html +++ b/docs/enums/SmartModuleType.html @@ -1,5 +1,5 @@ -SmartModuleType | @fluvio/client

    Enumeration SmartModuleType

    Enumeration Members

    ArrayMap +SmartModuleType | @fluvio/client

    Enumeration SmartModuleType

    Enumeration Members

    ArrayMap Filter FilterMap Map -

    Enumeration Members

    ArrayMap

    ArrayMap: "array_map"

    Filter

    Filter: "filter"

    FilterMap

    FilterMap: "filter_map"

    Map

    Map: "map"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    ArrayMap

    ArrayMap: "array_map"

    Filter

    Filter: "filter"

    FilterMap

    FilterMap: "filter_map"

    Map

    Map: "map"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/arrayBufferToString.html b/docs/functions/arrayBufferToString.html index 41e5779d..19219ca7 100644 --- a/docs/functions/arrayBufferToString.html +++ b/docs/functions/arrayBufferToString.html @@ -1 +1 @@ -arrayBufferToString | @fluvio/client

    Function arrayBufferToString

    • arrayBufferToString(data): string

    • Parameters

      • data: ArrayBuffer

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +arrayBufferToString | @fluvio/client

    Function arrayBufferToString

    • arrayBufferToString(data): string

    • Parameters

      • data: ArrayBuffer

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/stringToArrayBuffer.html b/docs/functions/stringToArrayBuffer.html index 80f9696e..a3056d73 100644 --- a/docs/functions/stringToArrayBuffer.html +++ b/docs/functions/stringToArrayBuffer.html @@ -1 +1 @@ -stringToArrayBuffer | @fluvio/client

    Function stringToArrayBuffer

    • stringToArrayBuffer(data): ArrayBuffer

    • Parameters

      • data: string

      Returns ArrayBuffer

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +stringToArrayBuffer | @fluvio/client

    Function stringToArrayBuffer

    • stringToArrayBuffer(data): ArrayBuffer

    • Parameters

      • data: string

      Returns ArrayBuffer

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Batch.html b/docs/interfaces/Batch.html index 21838532..fab1beb0 100644 --- a/docs/interfaces/Batch.html +++ b/docs/interfaces/Batch.html @@ -1,5 +1,5 @@ -Batch | @fluvio/client

    Interface Batch

    interface Batch {
        baseOffset: number;
        batchLength: number;
        header: BatchHeader;
        records: DefaultRecord[];
    }

    Properties

    baseOffset +Batch | @fluvio/client

    Interface Batch

    interface Batch {
        baseOffset: number;
        batchLength: number;
        header: BatchHeader;
        records: DefaultRecord[];
    }

    Properties

    baseOffset batchLength header records -

    Properties

    baseOffset

    baseOffset: number

    batchLength

    batchLength: number

    header

    header: BatchHeader

    records

    records: DefaultRecord[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    baseOffset

    baseOffset: number

    batchLength

    batchLength: number

    header

    header: BatchHeader

    records

    records: DefaultRecord[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/BatchHeader.html b/docs/interfaces/BatchHeader.html index 053de7c3..40eb5659 100644 --- a/docs/interfaces/BatchHeader.html +++ b/docs/interfaces/BatchHeader.html @@ -1,4 +1,4 @@ -BatchHeader | @fluvio/client

    Interface BatchHeader

    interface BatchHeader {
        attributes: number;
        crc: number;
        firstSequence: number;
        firstTimestamp: number;
        lastOffsetDelta: number;
        magic: number;
        maxTimeStamp: number;
        partitionLeaderEpoch: number;
        producerEpoch: number;
        producerId: number;
    }

    Properties

    attributes +BatchHeader | @fluvio/client

    Interface BatchHeader

    interface BatchHeader {
        attributes: number;
        crc: number;
        firstSequence: number;
        firstTimestamp: number;
        lastOffsetDelta: number;
        magic: number;
        maxTimeStamp: number;
        partitionLeaderEpoch: number;
        producerEpoch: number;
        producerId: number;
    }

    Properties

    attributes crc firstSequence firstTimestamp @@ -8,4 +8,4 @@ partitionLeaderEpoch producerEpoch producerId -

    Properties

    attributes

    attributes: number

    crc

    crc: number

    firstSequence

    firstSequence: number

    firstTimestamp

    firstTimestamp: number

    lastOffsetDelta

    lastOffsetDelta: number

    magic

    magic: number

    maxTimeStamp

    maxTimeStamp: number

    partitionLeaderEpoch

    partitionLeaderEpoch: number

    producerEpoch

    producerEpoch: number

    producerId

    producerId: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    attributes

    attributes: number

    crc

    crc: number

    firstSequence

    firstSequence: number

    firstTimestamp

    firstTimestamp: number

    lastOffsetDelta

    lastOffsetDelta: number

    magic

    magic: number

    maxTimeStamp

    maxTimeStamp: number

    partitionLeaderEpoch

    partitionLeaderEpoch: number

    producerEpoch

    producerEpoch: number

    producerId

    producerId: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ConsumerConfig.html b/docs/interfaces/ConsumerConfig.html index 48ecdf7f..392c8137 100644 --- a/docs/interfaces/ConsumerConfig.html +++ b/docs/interfaces/ConsumerConfig.html @@ -1,10 +1,10 @@ -ConsumerConfig | @fluvio/client

    Interface ConsumerConfig

    interface ConsumerConfig {
        maxBytes?: number;
        smartmoduleData?: string;
        smartmoduleFile?: string;
        smartmoduleName?: string;
        smartmoduleType: SmartModuleType;
    }

    Properties

    maxBytes? +ConsumerConfig | @fluvio/client

    Interface ConsumerConfig

    interface ConsumerConfig {
        maxBytes?: number;
        smartmoduleData?: string;
        smartmoduleFile?: string;
        smartmoduleName?: string;
        smartmoduleType: SmartModuleType;
    }

    Properties

    maxBytes? smartmoduleData? smartmoduleFile? smartmoduleName? smartmoduleType -

    Properties

    Optional maxBytes

    maxBytes?: number

    Optional smartmoduleData

    smartmoduleData?: string

    Gzipped and Base64 encoded SmartModule WASM file.

    -

    Optional smartmoduleFile

    smartmoduleFile?: string

    Path to a SmartModule WASM file.

    +

    Properties

    Optional maxBytes

    maxBytes?: number

    Optional smartmoduleData

    smartmoduleData?: string

    Gzipped and Base64 encoded SmartModule WASM file.

    +

    Optional smartmoduleFile

    smartmoduleFile?: string

    Path to a SmartModule WASM file.

    Remarks

    Internally replaces the value provided to smartmoduleData, you must provide one, either smartmoduleFile or smartmoduleData.

    -

    Optional smartmoduleName

    smartmoduleName?: string

    smartmoduleType

    smartmoduleType: SmartModuleType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional smartmoduleName

    smartmoduleName?: string

    smartmoduleType

    smartmoduleType: SmartModuleType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/DefaultRecord.html b/docs/interfaces/DefaultRecord.html index 262bc076..29f885d3 100644 --- a/docs/interfaces/DefaultRecord.html +++ b/docs/interfaces/DefaultRecord.html @@ -1,4 +1,4 @@ -DefaultRecord | @fluvio/client

    Interface DefaultRecord

    interface DefaultRecord {
        headers: number;
        key: string;
        value: string;
    }

    Properties

    headers +DefaultRecord | @fluvio/client

    Interface DefaultRecord

    interface DefaultRecord {
        headers: number;
        key: string;
        value: string;
    }

    Properties

    headers key value -

    Properties

    headers

    headers: number

    key

    key: string

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    headers

    headers: number

    key

    key: string

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Endpoint.html b/docs/interfaces/Endpoint.html index 295723d2..bdb09032 100644 --- a/docs/interfaces/Endpoint.html +++ b/docs/interfaces/Endpoint.html @@ -1,4 +1,4 @@ -Endpoint | @fluvio/client

    Interface Endpoint

    interface Endpoint {
        encryption: string;
        host: string;
        port: number;
    }

    Properties

    encryption +Endpoint | @fluvio/client

    Interface Endpoint

    interface Endpoint {
        encryption: string;
        host: string;
        port: number;
    }

    Properties

    encryption host port -

    Properties

    encryption

    encryption: string

    host

    host: string

    port

    port: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    encryption

    encryption: string

    host

    host: string

    port

    port: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/EnvVar.html b/docs/interfaces/EnvVar.html index 7eb67a2d..eb609bd9 100644 --- a/docs/interfaces/EnvVar.html +++ b/docs/interfaces/EnvVar.html @@ -1,3 +1,3 @@ -EnvVar | @fluvio/client

    Interface EnvVar

    interface EnvVar {
        name: string;
        value: string;
    }

    Properties

    name +EnvVar | @fluvio/client

    Interface EnvVar

    interface EnvVar {
        name: string;
        value: string;
    }

    Properties

    name value -

    Properties

    name

    name: string

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    name

    name: string

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/FetchablePartitionResponse.html b/docs/interfaces/FetchablePartitionResponse.html index 6a9f8f27..3b70142a 100644 --- a/docs/interfaces/FetchablePartitionResponse.html +++ b/docs/interfaces/FetchablePartitionResponse.html @@ -1,4 +1,4 @@ -FetchablePartitionResponse | @fluvio/client

    Interface FetchablePartitionResponse

    interface FetchablePartitionResponse {
        aborted?: ArrayBuffer;
        errorCode: ErrorCode;
        highWatermark: number;
        lastStableOffset: number;
        logStartOffset: number;
        partitionIndex: number;
        records: RecordSet;
        toRecords(): string[];
    }

    Properties

    aborted? +FetchablePartitionResponse | @fluvio/client

    Interface FetchablePartitionResponse

    interface FetchablePartitionResponse {
        aborted?: ArrayBuffer;
        errorCode: ErrorCode;
        highWatermark: number;
        lastStableOffset: number;
        logStartOffset: number;
        partitionIndex: number;
        records: RecordSet;
        toRecords(): string[];
    }

    Properties

    aborted? errorCode highWatermark lastStableOffset @@ -6,6 +6,6 @@ partitionIndex records

    Methods

    toRecords -

    Properties

    Optional aborted

    aborted?: ArrayBuffer

    errorCode

    errorCode: ErrorCode

    highWatermark

    highWatermark: number

    lastStableOffset

    lastStableOffset: number

    logStartOffset

    logStartOffset: number

    partitionIndex

    partitionIndex: number

    records

    records: RecordSet

    Methods

    toRecords

    • toRecords(): string[]
    • let response = await this.fluvioConsumer.fetch(Offset.FromStart())
      response.toRecords().forEach(msg => {
         console.log(msg)
      })
+

    Properties

    Optional aborted

    aborted?: ArrayBuffer

    errorCode

    errorCode: ErrorCode

    highWatermark

    highWatermark: number

    lastStableOffset

    lastStableOffset: number

    logStartOffset

    logStartOffset: number

    partitionIndex

    partitionIndex: number

    records

    records: RecordSet

    Methods

    toRecords

    • toRecords(): string[]
    • let response = await this.fluvioConsumer.fetch(Offset.FromStart())
      response.toRecords().forEach(msg => {
         console.log(msg)
      })
      -

      Returns string[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/FluvioClient.html b/docs/interfaces/FluvioClient.html index 7083ac54..1e0bd3d8 100644 --- a/docs/interfaces/FluvioClient.html +++ b/docs/interfaces/FluvioClient.html @@ -1,5 +1,5 @@ -FluvioClient | @fluvio/client

    Interface FluvioClient

    interface FluvioClient {
        admin(): Promise<FluvioAdmin>;
        connect(options?): Promise<FluvioClient>;
        partitionConsumer(topic, partition): Promise<PartitionConsumer>;
        topicProducer(topic): Promise<TopicProducer>;
    }

    Implemented by

    Methods

    admin +FluvioClient | @fluvio/client

    Interface FluvioClient

    interface FluvioClient {
        admin(): Promise<FluvioAdmin>;
        connect(options?): Promise<FluvioClient>;
        partitionConsumer(topic, partition): Promise<PartitionConsumer>;
        topicProducer(topic): Promise<TopicProducer>;
    }

    Implemented by

    Methods

    admin connect partitionConsumer topicProducer -

    Methods

    admin

    connect

    partitionConsumer

    topicProducer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    admin

    connect

    partitionConsumer

    topicProducer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/IngressAddr.html b/docs/interfaces/IngressAddr.html index 594d758d..3951a3cf 100644 --- a/docs/interfaces/IngressAddr.html +++ b/docs/interfaces/IngressAddr.html @@ -1,3 +1,3 @@ -IngressAddr | @fluvio/client

    Interface IngressAddr

    interface IngressAddr {
        hostname?: string;
        ip?: string;
    }

    Properties

    hostname? +IngressAddr | @fluvio/client

    Interface IngressAddr

    interface IngressAddr {
        hostname?: string;
        ip?: string;
    }

    Properties

    hostname? ip? -

    Properties

    Optional hostname

    hostname?: string

    Optional ip

    ip?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional hostname

    hostname?: string

    Optional ip

    ip?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/IngressPort.html b/docs/interfaces/IngressPort.html index 7f439df3..8c37a26e 100644 --- a/docs/interfaces/IngressPort.html +++ b/docs/interfaces/IngressPort.html @@ -1,4 +1,4 @@ -IngressPort | @fluvio/client

    Interface IngressPort

    interface IngressPort {
        encryption: string;
        ingress: IngressAddr[];
        port: number;
    }

    Properties

    encryption +IngressPort | @fluvio/client

    Interface IngressPort

    interface IngressPort {
        encryption: string;
        ingress: IngressAddr[];
        port: number;
    }

    Properties

    encryption ingress port -

    Properties

    encryption

    encryption: string

    ingress

    ingress: IngressAddr[]

    port

    port: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    encryption

    encryption: string

    ingress

    ingress: IngressAddr[]

    port

    port: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Options.html b/docs/interfaces/Options.html index 6a80c65b..ab5a5fd0 100644 --- a/docs/interfaces/Options.html +++ b/docs/interfaces/Options.html @@ -5,7 +5,7 @@

    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.

    -
    interface Options {
        encryption?: Encryption;
        env?: EnvVar[];
        host?: string;
        id?: number;
        ignoreRackAssignment?: boolean;
        ingress?: IngressAddr[];
        maps?: PartitionMap[];
        minId?: number;
        offsetFrom?: string;
        offsetIndex?: number;
        partition?: number;
        partitions?: number;
        port?: number;
        rack?: string;
        replicas?: number;
        replication?: ReplicationConfig;
        replicationFactor?: number;
        storage?: StorageConfig;
        topic?: string;
    }

    Properties

    encryption? +
    interface Options {
        encryption?: Encryption;
        env?: EnvVar[];
        host?: string;
        id?: number;
        ignoreRackAssignment?: boolean;
        ingress?: IngressAddr[];
        maps?: PartitionMap[];
        minId?: number;
        offsetFrom?: string;
        offsetIndex?: number;
        partition?: number;
        partitions?: number;
        port?: number;
        rack?: string;
        replicas?: number;
        replication?: ReplicationConfig;
        replicationFactor?: number;
        storage?: StorageConfig;
        topic?: string;
    }

    Properties

    encryption? env? host? id? @@ -24,4 +24,4 @@ replicationFactor? storage? topic? -

    Properties

    Optional encryption

    encryption?: Encryption

    Optional env

    env?: EnvVar[]

    Optional host

    host?: string

    Optional id

    id?: number

    Optional ignoreRackAssignment

    ignoreRackAssignment?: boolean

    Optional ingress

    ingress?: IngressAddr[]

    Optional maps

    maps?: PartitionMap[]

    Optional minId

    minId?: number

    Optional offsetFrom

    offsetFrom?: string

    Optional offsetIndex

    offsetIndex?: number

    Optional partition

    partition?: number

    Optional partitions

    partitions?: number

    Optional port

    port?: number

    Optional rack

    rack?: string

    Optional replicas

    replicas?: number

    Optional replication

    replication?: ReplicationConfig

    Optional replicationFactor

    replicationFactor?: number

    Optional storage

    storage?: StorageConfig

    Optional topic

    topic?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional encryption

    encryption?: Encryption

    Optional env

    env?: EnvVar[]

    Optional host

    host?: string

    Optional id

    id?: number

    Optional ignoreRackAssignment

    ignoreRackAssignment?: boolean

    Optional ingress

    ingress?: IngressAddr[]

    Optional maps

    maps?: PartitionMap[]

    Optional minId

    minId?: number

    Optional offsetFrom

    offsetFrom?: string

    Optional offsetIndex

    offsetIndex?: number

    Optional partition

    partition?: number

    Optional partitions

    partitions?: number

    Optional port

    port?: number

    Optional rack

    rack?: string

    Optional replicas

    replicas?: number

    Optional replication

    replication?: ReplicationConfig

    Optional replicationFactor

    replicationFactor?: number

    Optional storage

    storage?: StorageConfig

    Optional topic

    topic?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PartitionMap.html b/docs/interfaces/PartitionMap.html index 3d9a0711..c0bac6af 100644 --- a/docs/interfaces/PartitionMap.html +++ b/docs/interfaces/PartitionMap.html @@ -1,3 +1,3 @@ -PartitionMap | @fluvio/client

    Interface PartitionMap

    interface PartitionMap {
        id: number;
        replicas: number[];
    }

    Properties

    id +PartitionMap | @fluvio/client

    Interface PartitionMap

    interface PartitionMap {
        id: number;
        replicas: number[];
    }

    Properties

    id replicas -

    Properties

    id

    id: number

    replicas

    replicas: number[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    id

    id: number

    replicas

    replicas: number[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PartitionMaps.html b/docs/interfaces/PartitionMaps.html index ad9a1720..1bb3aa6c 100644 --- a/docs/interfaces/PartitionMaps.html +++ b/docs/interfaces/PartitionMaps.html @@ -1,2 +1,2 @@ -PartitionMaps | @fluvio/client

    Interface PartitionMaps

    interface PartitionMaps {
        maps: PartitionMap[];
    }

    Properties

    maps -

    Properties

    maps

    maps: PartitionMap[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +PartitionMaps | @fluvio/client

    Interface PartitionMaps

    interface PartitionMaps {
        maps: PartitionMap[];
    }

    Properties

    maps +

    Properties

    maps

    maps: PartitionMap[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PartitionSpec.html b/docs/interfaces/PartitionSpec.html index 41c26e53..e594cb3c 100644 --- a/docs/interfaces/PartitionSpec.html +++ b/docs/interfaces/PartitionSpec.html @@ -1,3 +1,3 @@ -PartitionSpec | @fluvio/client

    Interface PartitionSpec

    interface PartitionSpec {
        leader: number;
        replicas: number[];
    }

    Properties

    leader +PartitionSpec | @fluvio/client

    Interface PartitionSpec

    interface PartitionSpec {
        leader: number;
        replicas: number[];
    }

    Properties

    leader replicas -

    Properties

    leader

    leader: number

    replicas

    replicas: number[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    leader

    leader: number

    replicas

    replicas: number[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PartitionSpecMetadata.html b/docs/interfaces/PartitionSpecMetadata.html index bec046c6..dbd5a51f 100644 --- a/docs/interfaces/PartitionSpecMetadata.html +++ b/docs/interfaces/PartitionSpecMetadata.html @@ -1,4 +1,4 @@ -PartitionSpecMetadata | @fluvio/client

    Interface PartitionSpecMetadata

    interface PartitionSpecMetadata {
        name: string;
        spec: PartitionSpec;
        status: PartitionSpecStatus;
    }

    Properties

    name +PartitionSpecMetadata | @fluvio/client

    Interface PartitionSpecMetadata

    interface PartitionSpecMetadata {
        name: string;
        spec: PartitionSpec;
        status: PartitionSpecStatus;
    }

    Properties

    name spec status -

    Properties

    name

    name: string

    spec

    spec: PartitionSpec

    status

    status: PartitionSpecStatus

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    name

    name: string

    spec

    spec: PartitionSpec

    status

    status: PartitionSpecStatus

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PartitionSpecStatus.html b/docs/interfaces/PartitionSpecStatus.html index d4a3685c..5c752f9b 100644 --- a/docs/interfaces/PartitionSpecStatus.html +++ b/docs/interfaces/PartitionSpecStatus.html @@ -1,5 +1,5 @@ -PartitionSpecStatus | @fluvio/client

    Interface PartitionSpecStatus

    interface PartitionSpecStatus {
        leader: ReplicaStatus;
        lsr: string;
        replicas: ReplicaStatus[];
        resolution: string;
    }

    Properties

    leader +PartitionSpecStatus | @fluvio/client

    Interface PartitionSpecStatus

    interface PartitionSpecStatus {
        leader: ReplicaStatus;
        lsr: string;
        replicas: ReplicaStatus[];
        resolution: string;
    }

    Properties

    leader lsr replicas resolution -

    Properties

    leader

    leader: ReplicaStatus

    lsr

    lsr: string

    replicas

    replicas: ReplicaStatus[]

    resolution

    resolution: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    leader

    leader: ReplicaStatus

    lsr

    lsr: string

    replicas

    replicas: ReplicaStatus[]

    resolution

    resolution: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Record.html b/docs/interfaces/Record.html index 1bfdcf53..b888c6af 100644 --- a/docs/interfaces/Record.html +++ b/docs/interfaces/Record.html @@ -1,12 +1,12 @@ Record | @fluvio/client

    Interface Record

    Provides access to the data within a Record that was consumed

    -
    interface Record {
        hasKey(): boolean;
        key(): null | ArrayBuffer;
        keyString(): null | string;
        value(): ArrayBuffer;
        valueString(): string;
    }

    Methods

    hasKey +
    interface Record {
        hasKey(): boolean;
        key(): null | ArrayBuffer;
        keyString(): null | string;
        value(): ArrayBuffer;
        valueString(): string;
    }

    Methods

    hasKey key keyString value valueString

    Methods

    hasKey

    • hasKey(): boolean

    • Returns true if this Record has a key, or false otherwise

      -

      Returns boolean

    key

    • key(): null | ArrayBuffer

    • Returns the Key of this Record as a byte buffer, or null if there is no key

      -

      Returns null | ArrayBuffer

    keyString

    • keyString(): null | string

    • Returns the Key of this Record as a string, or null if there is no key

      -

      Returns null | string

    value

    • value(): ArrayBuffer

    • Returns the Value of this Record as a byte buffer

      -

      Returns ArrayBuffer

    valueString

    • valueString(): string

    • Returns the Value of this Record as a string

      -

      Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    key

    • key(): null | ArrayBuffer

    • Returns the Key of this Record as a byte buffer, or null if there is no key

      +

      Returns null | ArrayBuffer

    keyString

    • keyString(): null | string

    • Returns the Key of this Record as a string, or null if there is no key

      +

      Returns null | string

    value

    • value(): ArrayBuffer

    • Returns the Value of this Record as a byte buffer

      +

      Returns ArrayBuffer

    valueString

    • valueString(): string

    • Returns the Value of this Record as a string

      +

      Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/RecordSet.html b/docs/interfaces/RecordSet.html index 47d97b05..aa258a5e 100644 --- a/docs/interfaces/RecordSet.html +++ b/docs/interfaces/RecordSet.html @@ -1,2 +1,2 @@ -RecordSet | @fluvio/client

    Interface RecordSet

    interface RecordSet {
        batches: Batch[];
    }

    Properties

    batches -

    Properties

    batches

    batches: Batch[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +RecordSet | @fluvio/client

    Interface RecordSet

    interface RecordSet {
        batches: Batch[];
    }

    Properties

    batches +

    Properties

    batches

    batches: Batch[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ReplicaStatus.html b/docs/interfaces/ReplicaStatus.html index 4b2c5530..bc8bad4d 100644 --- a/docs/interfaces/ReplicaStatus.html +++ b/docs/interfaces/ReplicaStatus.html @@ -1,4 +1,4 @@ -ReplicaStatus | @fluvio/client

    Interface ReplicaStatus

    interface ReplicaStatus {
        hw: number;
        leo: number;
        spu: number;
    }

    Properties

    hw +ReplicaStatus | @fluvio/client

    Interface ReplicaStatus

    interface ReplicaStatus {
        hw: number;
        leo: number;
        spu: number;
    }

    Properties

    hw leo spu -

    Properties

    hw

    hw: number

    leo

    leo: number

    spu

    spu: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    hw

    hw: number

    leo

    leo: number

    spu

    spu: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ReplicationConfig.html b/docs/interfaces/ReplicationConfig.html index dfe88a4f..9e93e779 100644 --- a/docs/interfaces/ReplicationConfig.html +++ b/docs/interfaces/ReplicationConfig.html @@ -1,2 +1,2 @@ -ReplicationConfig | @fluvio/client

    Interface ReplicationConfig

    interface ReplicationConfig {
        inSyncReplicaMin?: number;
    }

    Properties

    inSyncReplicaMin? -

    Properties

    Optional inSyncReplicaMin

    inSyncReplicaMin?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +ReplicationConfig | @fluvio/client

    Interface ReplicationConfig

    interface ReplicationConfig {
        inSyncReplicaMin?: number;
    }

    Properties

    inSyncReplicaMin? +

    Properties

    Optional inSyncReplicaMin

    inSyncReplicaMin?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/StorageConfig.html b/docs/interfaces/StorageConfig.html index a8801a82..b8fe02de 100644 --- a/docs/interfaces/StorageConfig.html +++ b/docs/interfaces/StorageConfig.html @@ -1,3 +1,3 @@ -StorageConfig | @fluvio/client

    Interface StorageConfig

    interface StorageConfig {
        logDir?: string;
        size?: string;
    }

    Properties

    logDir? +StorageConfig | @fluvio/client

    Interface StorageConfig

    interface StorageConfig {
        logDir?: string;
        size?: string;
    }

    Properties

    logDir? size? -

    Properties

    Optional logDir

    logDir?: string

    Optional size

    size?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional logDir

    logDir?: string

    Optional size

    size?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Topic.html b/docs/interfaces/Topic.html index 963efa68..85d170f1 100644 --- a/docs/interfaces/Topic.html +++ b/docs/interfaces/Topic.html @@ -1,4 +1,4 @@ -Topic | @fluvio/client

    Interface Topic

    interface Topic {
        name: string;
        spec: {
            ignoreRackAssignment: boolean;
            partitions: number;
            replicationFactor: number;
            type: string;
        };
        status: {
            reason: string;
            replicaMap: {
                [key: string]: string;
            };
            resolution: string;
        };
    }

    Properties

    name +Topic | @fluvio/client

    Interface Topic

    interface Topic {
        name: string;
        spec: {
            ignoreRackAssignment: boolean;
            partitions: number;
            replicationFactor: number;
            type: string;
        };
        status: {
            reason: string;
            replicaMap: {
                [key: string]: string;
            };
            resolution: string;
        };
    }

    Properties

    name spec status -

    Properties

    name

    name: string

    spec

    spec: {
        ignoreRackAssignment: boolean;
        partitions: number;
        replicationFactor: number;
        type: string;
    }

    Type declaration

    • ignoreRackAssignment: boolean
    • partitions: number
    • replicationFactor: number
    • type: string

    status

    status: {
        reason: string;
        replicaMap: {
            [key: string]: string;
        };
        resolution: string;
    }

    Type declaration

    • reason: string
    • replicaMap: {
          [key: string]: string;
      }
      • [key: string]: string
    • resolution: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    name

    name: string

    spec

    spec: {
        ignoreRackAssignment: boolean;
        partitions: number;
        replicationFactor: number;
        type: string;
    }

    Type declaration

    • ignoreRackAssignment: boolean
    • partitions: number
    • replicationFactor: number
    • type: string

    status

    status: {
        reason: string;
        replicaMap: {
            [key: string]: string;
        };
        resolution: string;
    }

    Type declaration

    • reason: string
    • replicaMap: {
          [key: string]: string;
      }
      • [key: string]: string
    • resolution: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TopicReplicaParam.html b/docs/interfaces/TopicReplicaParam.html index c63aaf46..0f3763fc 100644 --- a/docs/interfaces/TopicReplicaParam.html +++ b/docs/interfaces/TopicReplicaParam.html @@ -1,4 +1,4 @@ -TopicReplicaParam | @fluvio/client

    Interface TopicReplicaParam

    interface TopicReplicaParam {
        ignoreRackAssignment: boolean;
        partitions: number;
        replicationFactor: number;
    }

    Properties

    ignoreRackAssignment +TopicReplicaParam | @fluvio/client

    Interface TopicReplicaParam

    interface TopicReplicaParam {
        ignoreRackAssignment: boolean;
        partitions: number;
        replicationFactor: number;
    }

    Properties

    ignoreRackAssignment partitions replicationFactor -

    Properties

    ignoreRackAssignment

    ignoreRackAssignment: boolean

    partitions

    partitions: number

    replicationFactor

    replicationFactor: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    ignoreRackAssignment

    ignoreRackAssignment: boolean

    partitions

    partitions: number

    replicationFactor

    replicationFactor: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/KeyValue.html b/docs/types/KeyValue.html index 4e27adbb..cde125b0 100644 --- a/docs/types/KeyValue.html +++ b/docs/types/KeyValue.html @@ -1,2 +1,2 @@ KeyValue | @fluvio/client

    Type alias KeyValue

    KeyValue: [ProducerItem, ProducerItem]

    A key/value element that may be sent via the Producer.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/DEFAULT_HOST.html b/docs/variables/DEFAULT_HOST.html index 4d574408..ade36f71 100644 --- a/docs/variables/DEFAULT_HOST.html +++ b/docs/variables/DEFAULT_HOST.html @@ -1 +1 @@ -DEFAULT_HOST | @fluvio/client

    Variable DEFAULT_HOSTConst

    DEFAULT_HOST: "127.0.0.1" = '127.0.0.1'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DEFAULT_HOST | @fluvio/client

    Variable DEFAULT_HOSTConst

    DEFAULT_HOST: "127.0.0.1" = '127.0.0.1'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/DEFAULT_ID.html b/docs/variables/DEFAULT_ID.html index 8d25bbda..c702a008 100644 --- a/docs/variables/DEFAULT_ID.html +++ b/docs/variables/DEFAULT_ID.html @@ -1 +1 @@ -DEFAULT_ID | @fluvio/client

    Variable DEFAULT_IDConst

    DEFAULT_ID: 0 = 0

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DEFAULT_ID | @fluvio/client

    Variable DEFAULT_IDConst

    DEFAULT_ID: 0 = 0

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/DEFAULT_IGNORE_RACK_ASSIGNMENT.html b/docs/variables/DEFAULT_IGNORE_RACK_ASSIGNMENT.html index 89c76aad..c94a3693 100644 --- a/docs/variables/DEFAULT_IGNORE_RACK_ASSIGNMENT.html +++ b/docs/variables/DEFAULT_IGNORE_RACK_ASSIGNMENT.html @@ -1 +1 @@ -DEFAULT_IGNORE_RACK_ASSIGNMENT | @fluvio/client

    Variable DEFAULT_IGNORE_RACK_ASSIGNMENTConst

    DEFAULT_IGNORE_RACK_ASSIGNMENT: false = false

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DEFAULT_IGNORE_RACK_ASSIGNMENT | @fluvio/client

    Variable DEFAULT_IGNORE_RACK_ASSIGNMENTConst

    DEFAULT_IGNORE_RACK_ASSIGNMENT: false = false

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/DEFAULT_MIN_ID.html b/docs/variables/DEFAULT_MIN_ID.html index 989692c7..18bfa9ba 100644 --- a/docs/variables/DEFAULT_MIN_ID.html +++ b/docs/variables/DEFAULT_MIN_ID.html @@ -1 +1 @@ -DEFAULT_MIN_ID | @fluvio/client

    Variable DEFAULT_MIN_IDConst

    DEFAULT_MIN_ID: 0 = 0

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DEFAULT_MIN_ID | @fluvio/client

    Variable DEFAULT_MIN_IDConst

    DEFAULT_MIN_ID: 0 = 0

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/DEFAULT_OFFSET.html b/docs/variables/DEFAULT_OFFSET.html index 7cc5008a..036dfda5 100644 --- a/docs/variables/DEFAULT_OFFSET.html +++ b/docs/variables/DEFAULT_OFFSET.html @@ -1 +1 @@ -DEFAULT_OFFSET | @fluvio/client

    Variable DEFAULT_OFFSETConst

    DEFAULT_OFFSET: 0 = 0

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DEFAULT_OFFSET | @fluvio/client

    Variable DEFAULT_OFFSETConst

    DEFAULT_OFFSET: 0 = 0

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/DEFAULT_OFFSET_FROM.html b/docs/variables/DEFAULT_OFFSET_FROM.html index 52d2d11c..0d5d15aa 100644 --- a/docs/variables/DEFAULT_OFFSET_FROM.html +++ b/docs/variables/DEFAULT_OFFSET_FROM.html @@ -1 +1 @@ -DEFAULT_OFFSET_FROM | @fluvio/client

    Variable DEFAULT_OFFSET_FROMConst

    DEFAULT_OFFSET_FROM: "end" = 'end'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DEFAULT_OFFSET_FROM | @fluvio/client

    Variable DEFAULT_OFFSET_FROMConst

    DEFAULT_OFFSET_FROM: "end" = 'end'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/DEFAULT_PARTITIONS.html b/docs/variables/DEFAULT_PARTITIONS.html index 5c55157f..96587a82 100644 --- a/docs/variables/DEFAULT_PARTITIONS.html +++ b/docs/variables/DEFAULT_PARTITIONS.html @@ -1 +1 @@ -DEFAULT_PARTITIONS | @fluvio/client

    Variable DEFAULT_PARTITIONSConst

    DEFAULT_PARTITIONS: 1 = 1

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DEFAULT_PARTITIONS | @fluvio/client

    Variable DEFAULT_PARTITIONSConst

    DEFAULT_PARTITIONS: 1 = 1

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/DEFAULT_PORT.html b/docs/variables/DEFAULT_PORT.html index 1ae33dfc..193fcf1c 100644 --- a/docs/variables/DEFAULT_PORT.html +++ b/docs/variables/DEFAULT_PORT.html @@ -1 +1 @@ -DEFAULT_PORT | @fluvio/client

    Variable DEFAULT_PORTConst

    DEFAULT_PORT: 9003 = 9003

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DEFAULT_PORT | @fluvio/client

    Variable DEFAULT_PORTConst

    DEFAULT_PORT: 9003 = 9003

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/DEFAULT_PRIVATE_PORT.html b/docs/variables/DEFAULT_PRIVATE_PORT.html index a52104bd..ad0b7ec0 100644 --- a/docs/variables/DEFAULT_PRIVATE_PORT.html +++ b/docs/variables/DEFAULT_PRIVATE_PORT.html @@ -1 +1 @@ -DEFAULT_PRIVATE_PORT | @fluvio/client

    Variable DEFAULT_PRIVATE_PORTConst

    DEFAULT_PRIVATE_PORT: 9006 = 9006

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DEFAULT_PRIVATE_PORT | @fluvio/client

    Variable DEFAULT_PRIVATE_PORTConst

    DEFAULT_PRIVATE_PORT: 9006 = 9006

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/DEFAULT_PUBLIC_PORT.html b/docs/variables/DEFAULT_PUBLIC_PORT.html index 7e4a7b7f..f926e3eb 100644 --- a/docs/variables/DEFAULT_PUBLIC_PORT.html +++ b/docs/variables/DEFAULT_PUBLIC_PORT.html @@ -1 +1 @@ -DEFAULT_PUBLIC_PORT | @fluvio/client

    Variable DEFAULT_PUBLIC_PORTConst

    DEFAULT_PUBLIC_PORT: 9005 = 9005

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DEFAULT_PUBLIC_PORT | @fluvio/client

    Variable DEFAULT_PUBLIC_PORTConst

    DEFAULT_PUBLIC_PORT: 9005 = 9005

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/DEFAULT_REPLICAS.html b/docs/variables/DEFAULT_REPLICAS.html index 9ab2bb4f..5b4ead38 100644 --- a/docs/variables/DEFAULT_REPLICAS.html +++ b/docs/variables/DEFAULT_REPLICAS.html @@ -1 +1 @@ -DEFAULT_REPLICAS | @fluvio/client

    Variable DEFAULT_REPLICASConst

    DEFAULT_REPLICAS: 3 = 3

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DEFAULT_REPLICAS | @fluvio/client

    Variable DEFAULT_REPLICASConst

    DEFAULT_REPLICAS: 3 = 3

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/DEFAULT_REPLICATION_FACTOR.html b/docs/variables/DEFAULT_REPLICATION_FACTOR.html index a5d6abed..ed711840 100644 --- a/docs/variables/DEFAULT_REPLICATION_FACTOR.html +++ b/docs/variables/DEFAULT_REPLICATION_FACTOR.html @@ -1 +1 @@ -DEFAULT_REPLICATION_FACTOR | @fluvio/client

    Variable DEFAULT_REPLICATION_FACTORConst

    DEFAULT_REPLICATION_FACTOR: 1 = 1

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DEFAULT_REPLICATION_FACTOR | @fluvio/client

    Variable DEFAULT_REPLICATION_FACTORConst

    DEFAULT_REPLICATION_FACTOR: 1 = 1

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/DEFAULT_TOPIC.html b/docs/variables/DEFAULT_TOPIC.html index 4a940fed..ef3b30fb 100644 --- a/docs/variables/DEFAULT_TOPIC.html +++ b/docs/variables/DEFAULT_TOPIC.html @@ -1 +1 @@ -DEFAULT_TOPIC | @fluvio/client

    Variable DEFAULT_TOPICConst

    DEFAULT_TOPIC: "message" = 'message'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DEFAULT_TOPIC | @fluvio/client

    Variable DEFAULT_TOPICConst

    DEFAULT_TOPIC: "message" = 'message'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/PartitionConsumerJS.html b/docs/variables/PartitionConsumerJS.html index 59ce5979..23de94aa 100644 --- a/docs/variables/PartitionConsumerJS.html +++ b/docs/variables/PartitionConsumerJS.html @@ -1 +1 @@ -PartitionConsumerJS | @fluvio/client

    Variable PartitionConsumerJSConst

    PartitionConsumerJS: any = native.PartitionConsumerJS

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PartitionConsumerJS | @fluvio/client

    Variable PartitionConsumerJSConst

    PartitionConsumerJS: any = native.PartitionConsumerJS

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file