diff --git a/docs/classes/CustomSpuSpec.html b/docs/classes/CustomSpuSpec.html index be89e9fb..dd645d40 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

Optionalrack

rack?: string

Settings

Member Visibility

On This Page

constructoridprivateEndpointpublicEndpointrack
\ No newline at end of file +

Constructors

constructor

Properties

id

id: number

privateEndpoint

privateEndpoint: Endpoint

publicEndpoint

publicEndpoint: IngressPort

Optionalrack

rack?: string

Settings

Member Visibility

On This Page

constructoridprivateEndpointpublicEndpointrack
\ No newline at end of file diff --git a/docs/classes/FluvioAdmin.html b/docs/classes/FluvioAdmin.html index 894c7632..6885f3ba 100644 --- a/docs/classes/FluvioAdmin.html +++ b/docs/classes/FluvioAdmin.html @@ -10,7 +10,7 @@

Errors

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

-

Constructors

constructor +

Constructors

constructor

Properties

options?

Methods

createCustomSpu createManagedSpu @@ -28,29 +28,29 @@ 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();

  • Optionaloptions: Partial<Options>

    Optional values inherited from top-level options;

    -

Returns FluvioAdmin

Properties

Optionaloptions

options?: Partial<Options>

Methods

createCustomSpu

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

  • Parameters

    Returns Promise<void>

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

  • Create a new custom Streaming Processing Unit (SPU)

    +

Returns FluvioAdmin

Properties

Optionaloptions

options?: Partial<Options>

Methods

createCustomSpu

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

  • Parameters

    Returns Promise<void>

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

  • Create a new custom Streaming Processing Unit (SPU)

    Parameters

    • name: string

      Name of the custom spu;

    • Optionalspec: CustomSpuSpec

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

      -

    Returns Promise<void>

createManagedSpu

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

  • Parameters

    Returns Promise<void>

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

  • Create a new managed Streaming Processing Unit (SPU)

    +

Returns Promise<void>

createManagedSpu

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

  • Parameters

    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

    • Optionalspec: 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>

  • Parameters

    Returns Promise<string>

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

  • Create a new topic with an optional topic specification;

    +

Returns Promise<void>

createTopic

deleteCustomSpu

  • deleteCustomSpu(key): Promise<void>

  • Parameters

    • key: string | number

    Returns Promise<void>

  • deleteCustomSpu(key): Promise<void>

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

    +

Returns Promise<string>

deleteCustomSpu

  • deleteCustomSpu(key): Promise<void>

  • Parameters

    • key: string | 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>

  • Parameters

    • name: string

    Returns Promise<void>

  • deleteManagedSpu(name): Promise<void>

  • Delete a managed SPU by name

    +

Returns Promise<void>

deleteManagedSpu

  • deleteManagedSpu(name): Promise<void>

  • Parameters

    • name: string

    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>

  • Parameters

    • topic: string

    Returns Promise<string>

  • deleteTopic(topic): Promise<string>

  • Delete a topic by name

    +

Returns Promise<void>

deleteTopic

  • deleteTopic(topic): Promise<string>

  • Parameters

    • topic: string

    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

findTopic

  • findTopic(topic): Promise<Topic>

  • Parameters

    • topic: string

    Returns Promise<Topic>

  • findTopic(topic): Promise<Topic>

  • Find a topic by name

    +

Returns Promise<PartitionSpecMetadata>

findTopic

  • findTopic(topic): Promise<Topic>

  • Parameters

    • topic: string

    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>

  • Returns Promise<string>

  • listPartitions(): Promise<string>

  • List partitions

    -

    Returns Promise<string>

listSpu

  • listSpu(): Promise<string>

  • Returns Promise<string>

  • listSpu(): Promise<string>

  • List SPUs +

Returns Promise<Topic>

listPartitions

  • listPartitions(): Promise<string>

  • Returns Promise<string>

  • listPartitions(): Promise<string>

  • List partitions

    +

    Returns Promise<string>

listSpu

  • listSpu(): Promise<string>

  • Returns Promise<string>

  • listSpu(): Promise<string>

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

    -

    Returns Promise<string>

listTopic

  • listTopic(): Promise<string>

  • Returns Promise<string>

  • listTopic(): Promise<string>

  • List topics

    -

    Returns Promise<string>

Settings

Member Visibility

On This Page

constructoroptionscreateCustomSpucreateManagedSpucreateTopicdeleteCustomSpudeleteManagedSpudeleteTopicfindPartitionfindTopiclistPartitionslistSpulistTopic
\ No newline at end of file +

Returns Promise<string>

listTopic

Settings

Member Visibility

On This Page

constructoroptionscreateCustomSpucreateManagedSpucreateTopicdeleteCustomSpudeleteManagedSpudeleteTopicfindPartitionfindTopiclistPartitionslistSpulistTopic
\ No newline at end of file diff --git a/docs/classes/Offset.html b/docs/classes/Offset.html index 013f45df..c8331f18 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

Optionalfrom

from?: string

index

index: number

Methods

StaticFromBeginning

StaticFromEnd

Settings

Member Visibility

On This Page

constructorfromindexFromBeginningFromEnd
\ No newline at end of file +

Constructors

constructor

Properties

Optionalfrom

from?: string

index

index: number

Methods

StaticFromBeginning

StaticFromEnd

Settings

Member Visibility

On This Page

constructorfromindexFromBeginningFromEnd
\ No newline at end of file diff --git a/docs/classes/PartitionConsumer.html b/docs/classes/PartitionConsumer.html index d6803c11..35043002 100644 --- a/docs/classes/PartitionConsumer.html +++ b/docs/classes/PartitionConsumer.html @@ -13,21 +13,21 @@

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.

-

Methods

createStream +

Methods

createStream endStream fetch stream streamWithConfig create -

Methods

createStream

Methods

createStream

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

  • 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

stream

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

  • Parameters

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

        • Parameters

          Returns void

    Returns Promise<void>

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

  • Parameters

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

        • Parameters

          Returns void

    Returns Promise<void>

streamWithConfig

Staticcreate

Settings

Member Visibility

On This Page

createStreamendStreamfetchstreamstreamWithConfigcreate
\ No newline at end of file +

Returns Promise<FetchablePartitionResponse>

stream

streamWithConfig

Staticcreate

Settings

Member Visibility

On This Page

createStreamendStreamfetchstreamstreamWithConfigcreate
\ No newline at end of file diff --git a/docs/classes/SpuConfig.html b/docs/classes/SpuConfig.html index 01e999c3..b0d449b5 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[]

Optionalrack

rack?: string

Optionalreplication

replication?: ReplicationConfig

Optionalstorage

storage?: StorageConfig

Settings

Member Visibility

On This Page

constructorenvrackreplicationstorage
\ No newline at end of file +

Constructors

constructor

Properties

env

env: EnvVar[]

Optionalrack

rack?: string

Optionalreplication

replication?: ReplicationConfig

Optionalstorage

storage?: StorageConfig

Settings

Member Visibility

On This Page

constructorenvrackreplicationstorage
\ No newline at end of file diff --git a/docs/classes/SpuGroupSpec.html b/docs/classes/SpuGroupSpec.html index ed9fa269..4fb80baf 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

On This Page

constructorminIdreplicasspuConfig
\ No newline at end of file +

Constructors

constructor

Properties

minId

minId: number

replicas

replicas: number

spuConfig

spuConfig: SpuConfig

Settings

Member Visibility

On This Page

constructorminIdreplicasspuConfig
\ No newline at end of file diff --git a/docs/classes/TopicProducer.html b/docs/classes/TopicProducer.html index 71880381..5de9f5c7 100644 --- a/docs/classes/TopicProducer.html +++ b/docs/classes/TopicProducer.html @@ -11,19 +11,19 @@

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.

-

Methods

flush +

Methods

flush send sendAll sendRecord create -

Methods

flush

  • flush(): Promise<void>

  • Returns Promise<void>

  • flush(): Promise<void>

  • Returns Promise<void>

send

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

  • Parameters

    • key: ProducerItem
    • value: ProducerItem

    Returns Promise<void>

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

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

    +

Methods

flush

  • flush(): Promise<void>

  • Returns Promise<void>

  • flush(): Promise<void>

  • Returns Promise<void>

send

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

  • Parameters

    • key: ProducerItem
    • value: ProducerItem

    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>

  • 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>

  • Parameters

    • data: string
    • partition: number

    Returns Promise<void>

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

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

    +

Returns Promise<void>

sendAll

  • sendAll(records): Promise<void>

  • 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>

  • Parameters

    • data: string
    • partition: number

    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>

Staticcreate

  • create(inner): TopicProducer

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

Returns Promise<void>

Staticcreate

  • 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

On This Page

flushsendsendAllsendRecordcreate
\ No newline at end of file +

Returns TopicProducer

Settings

Member Visibility

On This Page

flushsendsendAllsendRecordcreate
\ No newline at end of file diff --git a/docs/classes/TopicSpec.html b/docs/classes/TopicSpec.html index 34536a1d..2313197d 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

On This Page

constructoropts
\ No newline at end of file +

Constructors

constructor

Properties

opts

opts: PartitionMaps | TopicReplicaParam

Settings

Member Visibility

On This Page

constructoropts
\ No newline at end of file diff --git a/docs/classes/default.html b/docs/classes/default.html index 697988d7..5b2afe65 100644 --- a/docs/classes/default.html +++ b/docs/classes/default.html @@ -6,7 +6,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

Methods

admin connect partitionConsumer @@ -14,22 +14,22 @@ connect

Constructors

constructor

  • new default(options?): default

  • Parameters

    • Optionaloptions: Options

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

      -

    Returns default

Methods

admin

connect

Methods

admin

connect

  • connect(options?): Promise<FluvioClient>

  • Parameters

    • Optionaloptions: 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

topicProducer

Returns Promise<PartitionConsumer>

topicProducer

Staticconnect

Returns Promise<TopicProducer>

Staticconnect

Settings

Member Visibility

On This Page

constructoradminconnectpartitionConsumertopicProducerconnect
\ No newline at end of file +

Returns Promise<default>

Settings

Member Visibility

On This Page

constructoradminconnectpartitionConsumertopicProducerconnect
\ No newline at end of file diff --git a/docs/enums/Encryption.html b/docs/enums/Encryption.html index 0c0cd841..02ac9151 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

On This Page

PlaintextSsl
\ No newline at end of file +

Enumeration Members

Plaintext

Plaintext: "Plaintext"

Ssl

Ssl: "Ssl"

Settings

Member Visibility

On This Page

PlaintextSsl
\ No newline at end of file diff --git a/docs/enums/ErrorCode.html b/docs/enums/ErrorCode.html index 09f016c7..176682ab 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

On This Page

NoneNotLeaderForPartitionOffsetOutOfRangePartitionNotLeaderPartitionPendingInitializationSpuAlreadyExistsSpuErrorSpuNotFoundSpuOfflineSpuRegisterationFailedStorageErrorTopicAlreadyExistsTopicErrorTopicInvalidConfigurationTopicNotFoundTopicPendingInitializationUnknownServerError
\ 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

On This Page

NoneNotLeaderForPartitionOffsetOutOfRangePartitionNotLeaderPartitionPendingInitializationSpuAlreadyExistsSpuErrorSpuNotFoundSpuOfflineSpuRegisterationFailedStorageErrorTopicAlreadyExistsTopicErrorTopicInvalidConfigurationTopicNotFoundTopicPendingInitializationUnknownServerError
\ No newline at end of file diff --git a/docs/enums/OffsetFrom.html b/docs/enums/OffsetFrom.html index 74c15901..860f4a03 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

On This Page

BeginningEnd
\ No newline at end of file +

Enumeration Members

Beginning

Beginning: "beginning"

End

End: "end"

Settings

Member Visibility

On This Page

BeginningEnd
\ No newline at end of file diff --git a/docs/enums/SmartModuleType.html b/docs/enums/SmartModuleType.html index abe44d64..0e0c4ade 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

On This Page

ArrayMapFilterFilterMapMap
\ 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

On This Page

ArrayMapFilterFilterMapMap
\ No newline at end of file diff --git a/docs/functions/arrayBufferToString.html b/docs/functions/arrayBufferToString.html index ab9f2b4d..cd7fcf4f 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
\ No newline at end of file +arrayBufferToString | @fluvio/client

Function arrayBufferToString

  • arrayBufferToString(data): string

  • Parameters

    • data: ArrayBuffer

    Returns string

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/stringToArrayBuffer.html b/docs/functions/stringToArrayBuffer.html index 395c4444..4530ff39 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
\ No newline at end of file +stringToArrayBuffer | @fluvio/client

Function stringToArrayBuffer

  • stringToArrayBuffer(data): ArrayBuffer

  • Parameters

    • data: string

    Returns ArrayBuffer

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/interfaces/Batch.html b/docs/interfaces/Batch.html index 847fe215..52203b7c 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

On This Page

baseOffsetbatchLengthheaderrecords
\ No newline at end of file +

Properties

baseOffset

baseOffset: number

batchLength

batchLength: number

header

header: BatchHeader

records

records: DefaultRecord[]

Settings

Member Visibility

On This Page

baseOffsetbatchLengthheaderrecords
\ No newline at end of file diff --git a/docs/interfaces/BatchHeader.html b/docs/interfaces/BatchHeader.html index fbf559ea..cfeaa8e4 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

On This Page

attributescrcfirstSequencefirstTimestamplastOffsetDeltamagicmaxTimeStamppartitionLeaderEpochproducerEpochproducerId
\ 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

On This Page

attributescrcfirstSequencefirstTimestamplastOffsetDeltamagicmaxTimeStamppartitionLeaderEpochproducerEpochproducerId
\ No newline at end of file diff --git a/docs/interfaces/ConsumerConfig.html b/docs/interfaces/ConsumerConfig.html index 0f732611..8e5752d5 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

OptionalmaxBytes

maxBytes?: number

OptionalsmartmoduleData

smartmoduleData?: string

Gzipped and Base64 encoded SmartModule WASM file.

-

OptionalsmartmoduleFile

smartmoduleFile?: string

Path to a SmartModule WASM file.

+

Properties

OptionalmaxBytes

maxBytes?: number

OptionalsmartmoduleData

smartmoduleData?: string

Gzipped and Base64 encoded SmartModule WASM file.

+

OptionalsmartmoduleFile

smartmoduleFile?: string

Path to a SmartModule WASM file.

Remarks

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

-

OptionalsmartmoduleName

smartmoduleName?: string

smartmoduleType

smartmoduleType: SmartModuleType

Settings

Member Visibility

On This Page

maxBytessmartmoduleDatasmartmoduleFilesmartmoduleNamesmartmoduleType
\ No newline at end of file +

OptionalsmartmoduleName

smartmoduleName?: string

smartmoduleType

smartmoduleType: SmartModuleType

Settings

Member Visibility

On This Page

maxBytessmartmoduleDatasmartmoduleFilesmartmoduleNamesmartmoduleType
\ No newline at end of file diff --git a/docs/interfaces/DefaultRecord.html b/docs/interfaces/DefaultRecord.html index bc370cae..a994facd 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

On This Page

headerskeyvalue
\ No newline at end of file +

Properties

headers

headers: number

key

key: string

value

value: string

Settings

Member Visibility

On This Page

headerskeyvalue
\ No newline at end of file diff --git a/docs/interfaces/Endpoint.html b/docs/interfaces/Endpoint.html index a89cb8f6..691720bb 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

On This Page

encryptionhostport
\ No newline at end of file +

Properties

encryption

encryption: string

host

host: string

port

port: number

Settings

Member Visibility

On This Page

encryptionhostport
\ No newline at end of file diff --git a/docs/interfaces/EnvVar.html b/docs/interfaces/EnvVar.html index 454b632a..a3ab432e 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

On This Page

namevalue
\ No newline at end of file +

Properties

name

name: string

value

value: string

Settings

Member Visibility

On This Page

namevalue
\ No newline at end of file diff --git a/docs/interfaces/FetchablePartitionResponse.html b/docs/interfaces/FetchablePartitionResponse.html index 4d075c0b..82df8c9c 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,7 +6,7 @@ partitionIndex records

Methods

toRecords -

Properties

Optionalaborted

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

Optionalaborted

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

On This Page

abortederrorCodehighWatermarklastStableOffsetlogStartOffsetpartitionIndexrecordstoRecords
\ No newline at end of file +

Returns string[]

Settings

Member Visibility

On This Page

abortederrorCodehighWatermarklastStableOffsetlogStartOffsetpartitionIndexrecordstoRecords
\ No newline at end of file diff --git a/docs/interfaces/FluvioClient.html b/docs/interfaces/FluvioClient.html index 71f06ffd..17912a68 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?: Partial<Options>): Promise<FluvioClient>;
    partitionConsumer(topic: string, partition: number): Promise<PartitionConsumer>;
    topicProducer(topic: string): Promise<TopicProducer>;
}

Implemented by

Methods

admin +FluvioClient | @fluvio/client

Interface FluvioClient

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

Implemented by

Methods

admin connect partitionConsumer topicProducer -

Methods

admin

connect

partitionConsumer

topicProducer

Settings

Member Visibility

On This Page

adminconnectpartitionConsumertopicProducer
\ No newline at end of file +

Methods

admin

connect

partitionConsumer

topicProducer

Settings

Member Visibility

On This Page

adminconnectpartitionConsumertopicProducer
\ No newline at end of file diff --git a/docs/interfaces/IngressAddr.html b/docs/interfaces/IngressAddr.html index 1a12205f..3f919a01 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

Optionalhostname

hostname?: string

Optionalip

ip?: string

Settings

Member Visibility

On This Page

hostnameip
\ No newline at end of file +

Properties

Optionalhostname

hostname?: string

Optionalip

ip?: string

Settings

Member Visibility

On This Page

hostnameip
\ No newline at end of file diff --git a/docs/interfaces/IngressPort.html b/docs/interfaces/IngressPort.html index b691b6a3..11b1f363 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

On This Page

encryptioningressport
\ No newline at end of file +

Properties

encryption

encryption: string

ingress

ingress: IngressAddr[]

port

port: number

Settings

Member Visibility

On This Page

encryptioningressport
\ No newline at end of file diff --git a/docs/interfaces/Options.html b/docs/interfaces/Options.html index c7ada7d0..16b2c981 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

Optionalencryption

encryption?: Encryption

Optionalenv

env?: EnvVar[]

Optionalhost

host?: string

Optionalid

id?: number

OptionalignoreRackAssignment

ignoreRackAssignment?: boolean

Optionalingress

ingress?: IngressAddr[]

Optionalmaps

maps?: PartitionMap[]

OptionalminId

minId?: number

OptionaloffsetFrom

offsetFrom?: string

OptionaloffsetIndex

offsetIndex?: number

Optionalpartition

partition?: number

Optionalpartitions

partitions?: number

Optionalport

port?: number

Optionalrack

rack?: string

Optionalreplicas

replicas?: number

Optionalreplication

replication?: ReplicationConfig

OptionalreplicationFactor

replicationFactor?: number

Optionalstorage

storage?: StorageConfig

Optionaltopic

topic?: string

Settings

Member Visibility

On This Page

encryptionenvhostidignoreRackAssignmentingressmapsminIdoffsetFromoffsetIndexpartitionpartitionsportrackreplicasreplicationreplicationFactorstoragetopic
\ No newline at end of file +

Properties

Optionalencryption

encryption?: Encryption

Optionalenv

env?: EnvVar[]

Optionalhost

host?: string

Optionalid

id?: number

OptionalignoreRackAssignment

ignoreRackAssignment?: boolean

Optionalingress

ingress?: IngressAddr[]

Optionalmaps

maps?: PartitionMap[]

OptionalminId

minId?: number

OptionaloffsetFrom

offsetFrom?: string

OptionaloffsetIndex

offsetIndex?: number

Optionalpartition

partition?: number

Optionalpartitions

partitions?: number

Optionalport

port?: number

Optionalrack

rack?: string

Optionalreplicas

replicas?: number

Optionalreplication

replication?: ReplicationConfig

OptionalreplicationFactor

replicationFactor?: number

Optionalstorage

storage?: StorageConfig

Optionaltopic

topic?: string

Settings

Member Visibility

On This Page

encryptionenvhostidignoreRackAssignmentingressmapsminIdoffsetFromoffsetIndexpartitionpartitionsportrackreplicasreplicationreplicationFactorstoragetopic
\ No newline at end of file diff --git a/docs/interfaces/PartitionMap.html b/docs/interfaces/PartitionMap.html index bdbc2563..9f96f904 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

On This Page

idreplicas
\ No newline at end of file +

Properties

id

id: number

replicas

replicas: number[]

Settings

Member Visibility

On This Page

idreplicas
\ No newline at end of file diff --git a/docs/interfaces/PartitionMaps.html b/docs/interfaces/PartitionMaps.html index f917bce8..1e3a6955 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

On This Page

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

Interface PartitionMaps

interface PartitionMaps {
    maps: PartitionMap[];
}

Properties

maps +

Properties

maps

maps: PartitionMap[]

Settings

Member Visibility

On This Page

maps
\ No newline at end of file diff --git a/docs/interfaces/PartitionSpec.html b/docs/interfaces/PartitionSpec.html index df339958..f5e8ad87 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

On This Page

leaderreplicas
\ No newline at end of file +

Properties

leader

leader: number

replicas

replicas: number[]

Settings

Member Visibility

On This Page

leaderreplicas
\ No newline at end of file diff --git a/docs/interfaces/PartitionSpecMetadata.html b/docs/interfaces/PartitionSpecMetadata.html index e716acdf..dff26d52 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

On This Page

namespecstatus
\ No newline at end of file +

Properties

name

name: string

spec

spec: PartitionSpec

status

status: PartitionSpecStatus

Settings

Member Visibility

On This Page

namespecstatus
\ No newline at end of file diff --git a/docs/interfaces/PartitionSpecStatus.html b/docs/interfaces/PartitionSpecStatus.html index 8567ad49..b2aad9bd 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

On This Page

leaderlsrreplicasresolution
\ No newline at end of file +

Properties

leader

leader: ReplicaStatus

lsr

lsr: string

replicas

replicas: ReplicaStatus[]

resolution

resolution: string

Settings

Member Visibility

On This Page

leaderlsrreplicasresolution
\ No newline at end of file diff --git a/docs/interfaces/Record.html b/docs/interfaces/Record.html index 86ac9dba..0cda62d2 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

On This Page

hasKeykeykeyStringvaluevalueString
\ No newline at end of file +

Returns boolean

key

keyString

value

valueString

Settings

Member Visibility

On This Page

hasKeykeykeyStringvaluevalueString
\ No newline at end of file diff --git a/docs/interfaces/RecordSet.html b/docs/interfaces/RecordSet.html index af1e2f34..566a8f9d 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

On This Page

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

Interface RecordSet

interface RecordSet {
    batches: Batch[];
}

Properties

batches +

Properties

batches

batches: Batch[]

Settings

Member Visibility

On This Page

batches
\ No newline at end of file diff --git a/docs/interfaces/ReplicaStatus.html b/docs/interfaces/ReplicaStatus.html index 707626e2..0ef7273c 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

On This Page

hwleospu
\ No newline at end of file +

Properties

hw

hw: number

leo

leo: number

spu

spu: number

Settings

Member Visibility

On This Page

hwleospu
\ No newline at end of file diff --git a/docs/interfaces/ReplicationConfig.html b/docs/interfaces/ReplicationConfig.html index 8a05b706..459c999c 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

OptionalinSyncReplicaMin

inSyncReplicaMin?: number

Settings

Member Visibility

On This Page

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

Interface ReplicationConfig

interface ReplicationConfig {
    inSyncReplicaMin?: number;
}

Properties

inSyncReplicaMin? +

Properties

OptionalinSyncReplicaMin

inSyncReplicaMin?: number

Settings

Member Visibility

On This Page

inSyncReplicaMin
\ No newline at end of file diff --git a/docs/interfaces/StorageConfig.html b/docs/interfaces/StorageConfig.html index c52676fc..73121622 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

OptionallogDir

logDir?: string

Optionalsize

size?: string

Settings

Member Visibility

On This Page

logDirsize
\ No newline at end of file +

Properties

OptionallogDir

logDir?: string

Optionalsize

size?: string

Settings

Member Visibility

On This Page

logDirsize
\ No newline at end of file diff --git a/docs/interfaces/Topic.html b/docs/interfaces/Topic.html index 977dc79d..652e0a0c 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;
}

status

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

Settings

Member Visibility

On This Page

namespecstatus
\ No newline at end of file +

Properties

name

name: string

spec

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

status

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

Settings

Member Visibility

On This Page

namespecstatus
\ No newline at end of file diff --git a/docs/interfaces/TopicReplicaParam.html b/docs/interfaces/TopicReplicaParam.html index a1410a1c..a6b31ff7 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

On This Page

ignoreRackAssignmentpartitionsreplicationFactor
\ No newline at end of file +

Properties

ignoreRackAssignment

ignoreRackAssignment: boolean

partitions

partitions: number

replicationFactor

replicationFactor: number

Settings

Member Visibility

On This Page

ignoreRackAssignmentpartitionsreplicationFactor
\ No newline at end of file diff --git a/docs/types/KeyValue.html b/docs/types/KeyValue.html index 69cff201..39b25021 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
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/variables/DEFAULT_HOST.html b/docs/variables/DEFAULT_HOST.html index e3c4801d..8c8b39fe 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
\ 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
\ No newline at end of file diff --git a/docs/variables/DEFAULT_ID.html b/docs/variables/DEFAULT_ID.html index 988dc221..48085713 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
\ No newline at end of file +DEFAULT_ID | @fluvio/client

Variable DEFAULT_IDConst

DEFAULT_ID: 0 = 0

Settings

Member Visibility
\ 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 f0c982a6..fe51e2d9 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
\ 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
\ No newline at end of file diff --git a/docs/variables/DEFAULT_MIN_ID.html b/docs/variables/DEFAULT_MIN_ID.html index 42ddc02f..993da206 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
\ No newline at end of file +DEFAULT_MIN_ID | @fluvio/client

Variable DEFAULT_MIN_IDConst

DEFAULT_MIN_ID: 0 = 0

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/variables/DEFAULT_OFFSET.html b/docs/variables/DEFAULT_OFFSET.html index 4cb1ad48..199bc18f 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
\ No newline at end of file +DEFAULT_OFFSET | @fluvio/client

Variable DEFAULT_OFFSETConst

DEFAULT_OFFSET: 0 = 0

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/variables/DEFAULT_OFFSET_FROM.html b/docs/variables/DEFAULT_OFFSET_FROM.html index 35693597..d889e54d 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
\ No newline at end of file +DEFAULT_OFFSET_FROM | @fluvio/client

Variable DEFAULT_OFFSET_FROMConst

DEFAULT_OFFSET_FROM: "end" = 'end'

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/variables/DEFAULT_PARTITIONS.html b/docs/variables/DEFAULT_PARTITIONS.html index ba8321c5..f93405ea 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
\ No newline at end of file +DEFAULT_PARTITIONS | @fluvio/client

Variable DEFAULT_PARTITIONSConst

DEFAULT_PARTITIONS: 1 = 1

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/variables/DEFAULT_PORT.html b/docs/variables/DEFAULT_PORT.html index 560ab6f8..22d7cb5b 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
\ No newline at end of file +DEFAULT_PORT | @fluvio/client

Variable DEFAULT_PORTConst

DEFAULT_PORT: 9003 = 9003

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/variables/DEFAULT_PRIVATE_PORT.html b/docs/variables/DEFAULT_PRIVATE_PORT.html index 1a989c87..d2521542 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
\ No newline at end of file +DEFAULT_PRIVATE_PORT | @fluvio/client

Variable DEFAULT_PRIVATE_PORTConst

DEFAULT_PRIVATE_PORT: 9006 = 9006

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/variables/DEFAULT_PUBLIC_PORT.html b/docs/variables/DEFAULT_PUBLIC_PORT.html index fe39e245..d8d6072c 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
\ No newline at end of file +DEFAULT_PUBLIC_PORT | @fluvio/client

Variable DEFAULT_PUBLIC_PORTConst

DEFAULT_PUBLIC_PORT: 9005 = 9005

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/variables/DEFAULT_REPLICAS.html b/docs/variables/DEFAULT_REPLICAS.html index 08c73d19..07f9aa73 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
\ No newline at end of file +DEFAULT_REPLICAS | @fluvio/client

Variable DEFAULT_REPLICASConst

DEFAULT_REPLICAS: 3 = 3

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/variables/DEFAULT_REPLICATION_FACTOR.html b/docs/variables/DEFAULT_REPLICATION_FACTOR.html index 409342bc..85374462 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
\ No newline at end of file +DEFAULT_REPLICATION_FACTOR | @fluvio/client

Variable DEFAULT_REPLICATION_FACTORConst

DEFAULT_REPLICATION_FACTOR: 1 = 1

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/variables/DEFAULT_TOPIC.html b/docs/variables/DEFAULT_TOPIC.html index 17b55076..bf7a0b75 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
\ No newline at end of file +DEFAULT_TOPIC | @fluvio/client

Variable DEFAULT_TOPICConst

DEFAULT_TOPIC: "message" = 'message'

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/variables/PartitionConsumerJS.html b/docs/variables/PartitionConsumerJS.html index 3ec9118e..a155c1e0 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
\ No newline at end of file +PartitionConsumerJS | @fluvio/client

Variable PartitionConsumerJSConst

PartitionConsumerJS: any = native.PartitionConsumerJS

Settings

Member Visibility
\ No newline at end of file