Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StreamrClient

Hierarchy

  • StreamEndpoints
  • LoginEndpoints
  • ReturnType<typeof Publisher>
  • Subscriber
  • EventEmitter
    • StreamrClient

Index

Constructors

Properties

Important Methods

Other Methods

Constructors

constructor

  • new StreamrClient(options?: Partial<Omit<StrictStreamrClientOptions, "dataUnion"> & { dataUnion: Partial<{ factoryMainnetAddress: string; factorySidechainAddress: string; minimumWithdrawTokenWei: string | number | BigNumber; payForTransport: boolean; templateMainnetAddress: string; templateSidechainAddress: string }> }>, connection?: StreamrConnection): StreamrClient

  • Parameters

    • options: Partial<Omit<StrictStreamrClientOptions, "dataUnion"> & { dataUnion: Partial<{ factoryMainnetAddress: string; factorySidechainAddress: string; minimumWithdrawTokenWei: string | number | BigNumber; payForTransport: boolean; templateMainnetAddress: string; templateSidechainAddress: string }> }> = {}
    • Optional connection: StreamrConnection

    Returns StreamrClient

Properties

options

options: StrictStreamrClientOptions

session

session: default

subscriptions

subscriptions: Subscriptions

Static prefixed

prefixed: string | boolean

Important Methods

connect

  • connect(): Promise<void>

createStream

  • createStream(props?: Partial<StreamProperties>): Promise<Stream>

  • Parameters

    • Optional props: Partial<StreamProperties>

      if id is specified, it can be full streamId or path

    Returns Promise<Stream>

disconnect

  • disconnect(): Promise<[unknown[], void]>

getOrCreateStream

  • getOrCreateStream(props: { id: string; name?: undefined } | { id?: undefined; name: string }): Promise<Stream>

  • Parameters

    • props: { id: string; name?: undefined } | { id?: undefined; name: string }

    Returns Promise<Stream>

getStream

  • getStream(streamId: string): Promise<Stream>

listStreams

  • listStreams(query?: StreamListQuery): Promise<Stream[]>

publish

  • publish(streamObjectOrId: StreamPartDefinition, content: object, timestamp?: string | number | Date, partitionKey?: string): Promise<any>

  • Parameters

    • streamObjectOrId: StreamPartDefinition
    • content: object
    • Optional timestamp: string | number | Date
    • Optional partitionKey: string

    Returns Promise<any>

resend

subscribe

unsubscribe

Static generateEthereumAccount

  • generateEthereumAccount(): { address: string; privateKey: string }

  • Returns { address: string; privateKey: string }

    • address: string
    • privateKey: string

Other Methods

addListener

  • addListener<T>(event: T, fn: (...args: any[]) => void, context?: any): StreamrClient

  • Type parameters

    • T: string | symbol

    Parameters

    • event: T
    • fn: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns StreamrClient

canEncrypt

  • canEncrypt(): boolean

count

  • count(options?: StreamPartDefinition): any

  • Parameters

    • Optional options: StreamPartDefinition

    Returns any

deployDataUnion

emit

  • emit<T>(event: T, ...args: any[]): boolean

  • Calls each of the listeners registered for a given event.

    Type parameters

    • T: string | symbol

    Parameters

    • event: T
    • Rest ...args: any[]

    Returns boolean

enableAutoConnect

  • enableAutoConnect(autoConnect?: boolean): void

enableAutoDisconnect

  • enableAutoDisconnect(autoDisconnect?: boolean): void

ensureConnected

  • ensureConnected(): Promise<void>

ensureDisconnected

  • ensureDisconnected(): Promise<[unknown[], void]>

eventNames

  • eventNames(): (string | symbol)[]

  • Return an array listing the events for which the emitter has registered listeners.

    Returns (string | symbol)[]

get

  • get(opts: StreamPartDefinition): any

getAddress

  • getAddress(): Promise<string>

getAll

  • getAll(): any

getDataUnion

  • getDataUnion(contractAddress: string): DataUnion

getPublisherId

  • getPublisherId(): Promise<string>

getSidechainTokenBalance

  • getSidechainTokenBalance(address: string): Promise<BigNumber>

  • Get token balance in "wei" (10^-18 parts) for given address in sidechain

    Parameters

    • address: string

    Returns Promise<BigNumber>

getStreamByName

  • getStreamByName(name: string): Promise<Stream>

getStreamLast

  • getStreamLast(streamObjectOrId: string | Stream): Promise<StreamMessageAsObject>

  • Parameters

    • streamObjectOrId: string | Stream

    Returns Promise<StreamMessageAsObject>

getStreamPartsByStorageNode

  • getStreamPartsByStorageNode(node: string | StorageNode): Promise<StreamPart[]>

  • Parameters

    • node: string | StorageNode

    Returns Promise<StreamPart[]>

getStreamPublishers

  • getStreamPublishers(streamId: string): Promise<string[]>

getStreamSubscribers

  • getStreamSubscribers(streamId: string): Promise<string[]>

getStreamValidationInfo

  • getStreamValidationInfo(streamId: string): Promise<StreamValidationInfo>

  • Parameters

    • streamId: string

    Returns Promise<StreamValidationInfo>

getSubscription

  • getSubscription(definition: StreamPartDefinition): any

getSubscriptionSession

  • getSubscriptionSession(...args: any[]): any

  • Parameters

    • Rest ...args: any[]

    Returns any

getSubscriptions

  • getSubscriptions(): any

getTokenBalance

  • getTokenBalance(address: string): Promise<BigNumber>

  • Get token balance in "wei" (10^-18 parts) for given address

    Parameters

    • address: string

    Returns Promise<BigNumber>

getUserId

  • getUserId(): Promise<string>

getUserInfo

  • getUserInfo(): Promise<UserDetails>

isConnected

  • isConnected(): boolean

isConnecting

  • isConnecting(): boolean

isDisconnected

  • isDisconnected(): boolean

isDisconnecting

  • isDisconnecting(): boolean

isStreamPublisher

  • isStreamPublisher(streamId: string, ethAddress: string): Promise<boolean>

  • Parameters

    • streamId: string
    • ethAddress: string

    Returns Promise<boolean>

isStreamSubscriber

  • isStreamSubscriber(streamId: string, ethAddress: string): Promise<boolean>

  • Parameters

    • streamId: string
    • ethAddress: string

    Returns Promise<boolean>

listenerCount

  • listenerCount(event: string | symbol): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners<T>(event: T): ((...args: any[]) => void)[]

  • Return the listeners registered for a given event.

    Type parameters

    • T: string | symbol

    Parameters

    • event: T

    Returns ((...args: any[]) => void)[]

logout

  • logout(): Promise<void>

nextConnection

  • nextConnection(): Promise<unknown>

off

  • off<T>(event: T, fn?: (...args: any[]) => void, context?: any, once?: boolean): StreamrClient

  • Type parameters

    • T: string | symbol

    Parameters

    • event: T
    • Optional fn: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns StreamrClient

on

  • on<T>(event: T, fn: (...args: any[]) => void, context?: any): StreamrClient

  • Add a listener for a given event.

    Type parameters

    • T: string | symbol

    Parameters

    • event: T
    • fn: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns StreamrClient

onError

  • onError(error: Error): void

once

  • once<T>(event: T, fn: (...args: any[]) => void, context?: any): StreamrClient

  • Add a one-time listener for a given event.

    Type parameters

    • T: string | symbol

    Parameters

    • event: T
    • fn: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns StreamrClient

publishHttp

  • publishHttp(streamObjectOrId: string | Stream, data: any, requestOptions?: any, keepAlive?: boolean): Promise<void>

  • Parameters

    • streamObjectOrId: string | Stream
    • data: any
    • requestOptions: any = {}
    • keepAlive: boolean = true

    Returns Promise<void>

rekey

  • rekey(streamId: string): Promise<void>

removeAllListeners

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: string | symbol

    Returns StreamrClient

removeListener

  • removeListener<T>(event: T, fn?: (...args: any[]) => void, context?: any, once?: boolean): StreamrClient

  • Remove the listeners of a given event.

    Type parameters

    • T: string | symbol

    Parameters

    • event: T
    • Optional fn: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns StreamrClient

resendSubscribe

rotateGroupKey

  • rotateGroupKey(streamId: string): Promise<void>

  • Parameters

    • streamId: string

    Returns Promise<void>

safeGetDataUnion

  • safeGetDataUnion(contractAddress: string): Promise<DataUnion>

setNextGroupKey

  • setNextGroupKey(streamId: string, newKey: GroupKey): Promise<void>

  • Parameters

    • streamId: string
    • newKey: GroupKey

    Returns Promise<void>

startKeyExchange

  • startKeyExchange(): Promise<void>

stop

  • stop(): Promise<void>

Generated using TypeDoc