Home Reference Source Test

Typedef

Static Public Summary
public
public
public
public
public

Static Public

public EventstoreSettings: Object source

Properties:

NameTypeAttributeDescription
uri string

connection uri (default=tcp://admin@changeit@127.0.0.1:1113)

useSSL boolean

indicates if to connect to secure tcp port (default=false)

secureContext SecureContextOptions | null

node tls.SecureContextOptions (default=null)

useHttps boolean

indicates if to use https for discovery (default=false)

host string

connection host name (will be ignored if uri is set)

port number

connection port (will be ignored if uri is set)

credentials UserCredentials

user credentials

requireMaster boolean

forces to connect to master node only if set to true (default=true)

logger bunyan

bunyan logger instance

maxQueueSize number

maximum pending requests (default=5000)

connectTimeout number

connect timeout in ms (default=1000)

maxReconnections number

maximum re-connection tries (default=10)

reconnectionDelay number

delay between reconnects in ms (default=2000)

operationTimeout number

time in ms until a request timed out if no response from eventstore arrives (default=7000)

operationTimeoutCheckPeriod number

time period in ms to check for timed out requests (default=1000)

clusterDns string

dns ip to use to discover eventstore cluster ip's (default=empty string)

maxDiscoverAttempts number

maximum count of discover attempts before giving up

externalGossipPort number

gossip ip port (default=2112)

gossipTimeout number

timeout in ms (default=1000)

gossipSeeds string[]

array list of eventstore cluster ip's

validateServer boolean

validate server ssl certificate (default=false)

clientId string

client id string to identify connection at eventstore (default=ts-client-uuid())

public ExpectedVersion: object source

public StreamOptions: object source

Properties:

NameTypeAttributeDescription
requireMaster boolean

indicates if operations require master node

resolveLinks boolean

indicates if event links should be resolved on read operations

credentials UserCredentials | null

user credentials if others than default connection credentials

public UserCredentials: object source

Properties:

NameTypeAttributeDescription
username string

username to use for authentication

password string

password to use for authentication

public WriteResult: object source

Properties:

NameTypeAttributeDescription
firstEventNumber Long | number
lastEventNumber Long | number
position Position