import {Stream} from 'eventstore-ts-client/src/stream/Stream.ts'

public class | source

Stream

Base class for handling a stream

Constructor Summary

Public Constructor
public	constructor() Creates an instance of Stream.

Member Summary

Public Members
public get	id: string Gets id of stream
public	log: bunyan bunyan logger
public get	name: string Return name of stream instance

Protected Members
protected	defaultSliceSize: number default read slice size
protected	esConnection: Eventstore eventstore instance
protected	options: StreamOptions stream options
protected	streamId: string id of stream

Method Summary

Public Methods
public	async append(event: Event, expectedVersion: *, requireMaster: , credentials: UserCredentials): Promise Append single event or array of events to stream
public	async createPersistentSubscription(subscriptionGroupName: , customConfig: {}, credentials: UserCredentials): Promise Creates a persistent subscription for current stream This operation needs admin rights and a master connection
public	async getEventByNumber(eventNumber: Long \| number, resolveLinks: , requireMaster: , credentials: UserCredentials): Promise Get event at specified position from stream
public	async getFirstEvent(resolveLinks: , requireMaster: , credentials: UserCredentials): Promise Returns first event from stream
public	async getLastEvent(resolveLinks: , requireMaster: , credentials: UserCredentials): Promise Returns last event from stream
public	async getMetadata(requireMaster: , credentials: UserCredentials): Promise Returns stream metadata if set or
public	getPersistentSubscription(subscriptionGroupName: , credentials: UserCredentials): PersistentSubscription Returns a instance of persistance subscription given by group name
public	async hardDelete(expectedVersion: *, requireMaster: , credentials: UserCredentials): Promise Hard deletes a stream - stream with same name can not be used in future
public	isMetaStream(): boolean Indicates if given stream is a metadata stream or a regular steam
public	async readSliceBackward(fromEventNumber: number \| Long, maxSliceCount: , resolveLinks: , requireMaster: , credentials: UserCredentials): Promise Read a slice from stream in backward direction starting at given position
public	async readSliceForward(fromEventNumber: number \| Long, maxSliceCount: , resolveLinks: , requireMaster: , credentials: UserCredentials): Promise Read a slice from stream in forward direction starting at given position
public	requiresMaster(): Stream Enforces to use master node for any read/write operation
public	resolveAllLinks(): Stream Enforce to resolve links on read operations
public	async setMetadata(newMetadata: , requireMaster: , credentials: UserCredentials): Promise Set metadata for stream
public	async softDelete(expectedVersion: *, requireMaster: , credentials: UserCredentials): Promise Soft deletes a stream - stream with same name can be used in future and indexes are preserved
public	async startTransaction(expectedVersion: *, requireMaster: , credentials: UserCredentials): Promise Creates a new instance of {Transaction} for current stream
public	async subscribe(resolveLinkTos: , credentials: UserCredentials): Promise Subscribe to current stream and return a subscription
public	async walkStreamBackward(start: *, resolveLinkTos: , requireMaster: , credentials: UserCredentials): Promise Walk through all events in stream backward
public	async walkStreamForward(start: *, resolveLinkTos: , requireMaster: , credentials: UserCredentials): Promise Walk through all events in stream forward
public	withCredentials(credentials: UserCredentials): Stream Set credentials for any read/write operation

Protected Methods
protected	appendEvents(events: , expectedVersion: ExpectedVersion \| number \| Long, requireMaster: , credentials: UserCredentials): Promise Appends array of events to stream
protected	delete(hardDelete: , expectedVersion: ExpectedVersion, requireMaster: , credentials: UserCredentials): Promise Delete a stream - can't be called directly Use softDelete or hardDelete instead
protected	async readSlice(direction: EventstoreCommand, fromEventNumber: number \| Long, maxSliceCount: , resolveLinks: , requireMaster: , credentials: UserCredentials): Promise Reads a slice from current stream in given direction starting at given position
protected	async walkStream(forward: , start: Long \| number, resolveLinks: , requireMaster: , credentials: UserCredentials): Promise Walk through all events of stream

Public Constructors

public constructor() source

Creates an instance of Stream.

Public Members

public get id: string source

Gets id of stream

public log: bunyan source

bunyan logger

public get name: string source

Return name of stream instance

Protected Members

protected defaultSliceSize: number source

default read slice size

protected esConnection: Eventstore source

eventstore instance

protected options: StreamOptions source

stream options

protected streamId: string source

id of stream

Public Methods

public async append(event: Event, expectedVersion: *, requireMaster: , credentials: UserCredentials): Promise source

Append single event or array of events to stream

Params:

Name	Type	Attribute	Description
event	Event
expectedVersion	*	optional
requireMaster
credentials	UserCredentials

public async createPersistentSubscription(subscriptionGroupName: , customConfig: {}, credentials: UserCredentials): Promise source

Creates a persistent subscription for current stream This operation needs admin rights and a master connection

Params:

Name	Type	Attribute	Description
subscriptionGroupName
customConfig	{}	optional default: {}
credentials	UserCredentials

public async getEventByNumber(eventNumber: Long | number, resolveLinks: , requireMaster: , credentials: UserCredentials): Promise source

Get event at specified position from stream

Params:

Name	Type	Attribute	Description
eventNumber	Long \| number
resolveLinks
requireMaster
credentials	UserCredentials

public async getFirstEvent(resolveLinks: , requireMaster: , credentials: UserCredentials): Promise source

Returns first event from stream

Params:

Name	Type	Attribute	Description
resolveLinks
requireMaster
credentials	UserCredentials

public async getLastEvent(resolveLinks: , requireMaster: , credentials: UserCredentials): Promise source

Returns last event from stream

Params:

Name	Type	Attribute	Description
resolveLinks
requireMaster
credentials	UserCredentials

public async getMetadata(requireMaster: , credentials: UserCredentials): Promise source

Returns stream metadata if set or

Params:

Name	Type	Attribute	Description
requireMaster
credentials	UserCredentials

public getPersistentSubscription(subscriptionGroupName: , credentials: UserCredentials): PersistentSubscription source

Returns a instance of persistance subscription given by group name

Params:

Name	Type	Attribute	Description
subscriptionGroupName
credentials	UserCredentials

public async hardDelete(expectedVersion: *, requireMaster: , credentials: UserCredentials): Promise source

Hard deletes a stream - stream with same name can not be used in future

Params:

Name	Type	Attribute	Description
expectedVersion	*	optional
requireMaster
credentials	UserCredentials

public isMetaStream(): boolean source

Indicates if given stream is a metadata stream or a regular steam

public async readSliceBackward(fromEventNumber: number | Long, maxSliceCount: , resolveLinks: , requireMaster: , credentials: UserCredentials): Promise source

Read a slice from stream in backward direction starting at given position

Params:

Name	Type	Attribute	Description
fromEventNumber	number \| Long
maxSliceCount
resolveLinks
requireMaster
credentials	UserCredentials

public async readSliceForward(fromEventNumber: number | Long, maxSliceCount: , resolveLinks: , requireMaster: , credentials: UserCredentials): Promise source

Read a slice from stream in forward direction starting at given position

Params:

Name	Type	Attribute	Description
fromEventNumber	number \| Long
maxSliceCount
resolveLinks
requireMaster
credentials	UserCredentials

public requiresMaster(): Stream source

Enforces to use master node for any read/write operation

public resolveAllLinks(): Stream source

Enforce to resolve links on read operations

public async setMetadata(newMetadata: , requireMaster: , credentials: UserCredentials): Promise source

Set metadata for stream

Params:

Name	Type	Attribute	Description
newMetadata
requireMaster
credentials	UserCredentials

public async softDelete(expectedVersion: *, requireMaster: , credentials: UserCredentials): Promise source

Soft deletes a stream - stream with same name can be used in future and indexes are preserved

Params:

Name	Type	Attribute	Description
expectedVersion	*	optional
requireMaster
credentials	UserCredentials

public async startTransaction(expectedVersion: *, requireMaster: , credentials: UserCredentials): Promise source

Creates a new instance of {Transaction} for current stream

Params:

Name	Type	Attribute	Description
expectedVersion	*	optional
requireMaster
credentials	UserCredentials

Subscribe to current stream and return a subscription

Params:

Name	Type	Attribute	Description
resolveLinkTos
credentials	UserCredentials

public async walkStreamBackward(start: *, resolveLinkTos: , requireMaster: , credentials: UserCredentials): Promise source

Walk through all events in stream backward

Params:

Name	Type	Attribute	Description
start	*	optional
resolveLinkTos
requireMaster
credentials	UserCredentials

public async walkStreamForward(start: *, resolveLinkTos: , requireMaster: , credentials: UserCredentials): Promise source

Walk through all events in stream forward

Params:

Name	Type	Attribute	Description
start	*	optional
resolveLinkTos
requireMaster
credentials	UserCredentials

public withCredentials(credentials: UserCredentials): Stream source

Set credentials for any read/write operation

Params:

Name	Type	Attribute	Description
credentials	UserCredentials

Protected Methods

protected appendEvents(events: , expectedVersion: ExpectedVersion | number | Long, requireMaster: , credentials: UserCredentials): Promise source

Appends array of events to stream

Params:

Name	Type	Attribute	Description
events
expectedVersion	ExpectedVersion \| number \| Long
requireMaster
credentials	UserCredentials

protected delete(hardDelete: , expectedVersion: ExpectedVersion, requireMaster: , credentials: UserCredentials): Promise source

Delete a stream - can't be called directly Use softDelete or hardDelete instead

Params:

Name	Type	Attribute	Description
hardDelete
expectedVersion	ExpectedVersion
requireMaster
credentials	UserCredentials

protected async readSlice(direction: EventstoreCommand, fromEventNumber: number | Long, maxSliceCount: , resolveLinks: , requireMaster: , credentials: UserCredentials): Promise source

Reads a slice from current stream in given direction starting at given position

Params:

Name	Type	Attribute	Description
direction	EventstoreCommand
fromEventNumber	number \| Long
maxSliceCount
resolveLinks
requireMaster
credentials	UserCredentials

protected async walkStream(forward: , start: Long | number, resolveLinks: , requireMaster: , credentials: UserCredentials): Promise source

Walk through all events of stream

Params:

Name	Type	Attribute	Description
forward
start	Long \| number
resolveLinks
requireMaster
credentials	UserCredentials

Stream

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor() source

Public Members

public get id: string source

public log: bunyan source

public get name: string source

Protected Members

protected defaultSliceSize: number source

protected esConnection: Eventstore source

protected options: StreamOptions source

protected streamId: string source

Public Methods

public async append(event: Event, expectedVersion: *, requireMaster: , credentials: UserCredentials): Promise source

Params:

public async createPersistentSubscription(subscriptionGroupName: , customConfig: {}, credentials: UserCredentials): Promise source

Params:

public async getEventByNumber(eventNumber: Long | number, resolveLinks: , requireMaster: , credentials: UserCredentials): Promise source

Params:

public async getFirstEvent(resolveLinks: , requireMaster: , credentials: UserCredentials): Promise source

Params:

public async getLastEvent(resolveLinks: , requireMaster: , credentials: UserCredentials): Promise source

Params:

public async getMetadata(requireMaster: , credentials: UserCredentials): Promise source

Params:

public getPersistentSubscription(subscriptionGroupName: , credentials: UserCredentials): PersistentSubscription source

Params:

public async hardDelete(expectedVersion: *, requireMaster: , credentials: UserCredentials): Promise source

Params:

public isMetaStream(): boolean source

public async readSliceBackward(fromEventNumber: number | Long, maxSliceCount: , resolveLinks: , requireMaster: , credentials: UserCredentials): Promise source

Params:

public async readSliceForward(fromEventNumber: number | Long, maxSliceCount: , resolveLinks: , requireMaster: , credentials: UserCredentials): Promise source

Params:

public requiresMaster(): Stream source

public resolveAllLinks(): Stream source

public async setMetadata(newMetadata: , requireMaster: , credentials: UserCredentials): Promise source

Params:

public async softDelete(expectedVersion: *, requireMaster: , credentials: UserCredentials): Promise source

Params:

public async startTransaction(expectedVersion: *, requireMaster: , credentials: UserCredentials): Promise source

Params:

public async subscribe(resolveLinkTos: , credentials: UserCredentials): Promise source

Params:

public async walkStreamBackward(start: *, resolveLinkTos: , requireMaster: , credentials: UserCredentials): Promise source

Params:

public async walkStreamForward(start: *, resolveLinkTos: , requireMaster: , credentials: UserCredentials): Promise source

Params:

public withCredentials(credentials: UserCredentials): Stream source

Params:

Protected Methods

protected appendEvents(events: , expectedVersion: ExpectedVersion | number | Long, requireMaster: , credentials: UserCredentials): Promise source

Params:

protected delete(hardDelete: , expectedVersion: ExpectedVersion, requireMaster: , credentials: UserCredentials): Promise source

Params:

protected async readSlice(direction: EventstoreCommand, fromEventNumber: number | Long, maxSliceCount: , resolveLinks: , requireMaster: , credentials: UserCredentials): Promise source

Params:

protected async walkStream(forward: , start: Long | number, resolveLinks: , requireMaster: , credentials: UserCredentials): Promise source

Params: