import {Subscription} from 'eventstore-ts-client/src/subscription/Subscription.ts'

public class | source

Subscription

Extends:

events~EventEmitter → Subscription

Constructor Summary

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

Member Summary

Public Members
public get	getCredentials: UserCredentials \| null Gets get credentials
public get	id: string Returns subscriptionId
public	isSubscribed: boolean indicates if subscription is running
public	log: bunyan logger
public get	name: string Returns subscription nam

Protected Members
protected	credentials: UserCredentials \| null credentials for subscription
protected	position: Position \| null global log position
protected	resolveLinkTos: boolean indicates if events should be full resolved
protected	stream: Stream instance of corresponding stream
protected	subscriptionId: string uuid4 of subscription
protected	tcpConnection: TCPConnection connection to use

Method Summary

Public Methods
public	eventAppeared(event: Event, position: Position): void Called when event from eventstore arrives
public	getResolveLinkTos(): boolean Gets resolve link tos
public	async unsubscribe(): Promise Unsubscribe from stream

Protected Methods
protected	onDropped(reason: ): void Called when subscription was dropped
protected	onError(err: Error): void Called when error appears
protected	onEvent(event: Event, position: Position): void Determines whether event on
protected	onSubscribed(): void Called when subscription is established

Public Constructors

public constructor() source

Creates an instance of subscription.

Public Members

public get getCredentials: UserCredentials | null source

Gets get credentials

public get id: string source

Returns subscriptionId

public isSubscribed: boolean source

indicates if subscription is running

public log: bunyan source

logger

public get name: string source

Returns subscription nam

Protected Members

protected credentials: UserCredentials | null source

credentials for subscription

protected position: Position | null source

global log position

protected resolveLinkTos: boolean source

indicates if events should be full resolved

protected stream: Stream source

instance of corresponding stream

protected subscriptionId: string source

uuid4 of subscription

protected tcpConnection: TCPConnection source

connection to use

Public Methods

public eventAppeared(event: Event, position: Position): void source

Called when event from eventstore arrives

Params:

Name	Type	Attribute	Description
event	Event
position	Position

public getResolveLinkTos(): boolean source

Gets resolve link tos

public async unsubscribe(): Promise source

Unsubscribe from stream

Protected Methods

protected onDropped(reason: ): void source

Called when subscription was dropped

Params:

Name	Type	Attribute	Description
reason

protected onError(err: Error): void source

Called when error appears

Params:

Name	Type	Attribute	Description
err	Error

protected onEvent(event: Event, position: Position): void source

Determines whether event on

Params:

Name	Type	Attribute	Description
event	Event
position	Position

protected onSubscribed(): void source

Called when subscription is established