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

public class | source

PersistentSubscription

Extends:

events~EventEmitter → PersistentSubscription

Represents a persistent subscription

Constructor Summary

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

Member Summary

Public Members
public	allowedInFlightMessages: number count of max concurrent events
public	autoAcknowledge: boolean indicate if incoming events should automatically acknowledged
public	id: string id of persistent subscription (uuid)
public	lastCommitPosition: Long last commit position
public	lastEventNumber: Long \| null last event number
public get	name: string Gets name
public get	state: SubscriptionStatus Gets state
public set	state: SubscriptionStatus Sets state
public	stream: Stream corresponding stream
public	subscriptionGroupName: string name of subscription
public	subscriptionId: string subscription id send back from eventstore

Protected Members
protected	credentials: UserCredentials \| null user credentials
protected	esConnection: Eventstore connection to use
protected	status: SubscriptionStatus status of subscription

Method Summary

Public Methods
public	acknowledgeEvent(event: Event, credentials: UserCredentials): void Acknowledges single event
public	acknowledgeEvents(events: , credentials: UserCredentials): void Acknowledges array of events
public	async delete(credentials: UserCredentials \| null): Promise Deletes persistent subscription
public	eventAppeared(event: Event): void Called when event from eventstore arrives
public	notAcknowledgeEvent(event: Event, reason: *, message: , credentials: UserCredentials): void Not acknowledge single event
public	notAcknowledgeEvents(events: , reason: *, message: , credentials: UserCredentials): void Not acknowledge array of events
public	async subscribe(allowedInFlightMessages: number, credentials: UserCredentials \| null): Promise Connects persistent subscription
public	async unsubscribe(credentials: UserCredentials \| null): Promise Unsubscribe from stream
public	async update(customConfig: PersistentSubscriptionConfig, credentials: UserCredentials): Promise Updates persistent subscription

Public Constructors

public constructor() source

Creates an instance of persistent subscription.

Public Members

public allowedInFlightMessages: number source

count of max concurrent events

public autoAcknowledge: boolean source

indicate if incoming events should automatically acknowledged

public id: string source

id of persistent subscription (uuid)

public lastCommitPosition: Long source

last commit position

public lastEventNumber: Long | null source

last event number

public get name: string source

Gets name

public get state: SubscriptionStatus source

Gets state

public set state: SubscriptionStatus source

Sets state

public stream: Stream source

corresponding stream

public subscriptionGroupName: string source

name of subscription

public subscriptionId: string source

subscription id send back from eventstore

Protected Members

protected credentials: UserCredentials | null source

user credentials

protected esConnection: Eventstore source

connection to use

protected status: SubscriptionStatus source

status of subscription

Public Methods

public acknowledgeEvent(event: Event, credentials: UserCredentials): void source

Acknowledges single event

Params:

Name	Type	Attribute	Description
event	Event
credentials	UserCredentials

public acknowledgeEvents(events: , credentials: UserCredentials): void source

Acknowledges array of events

Params:

Name	Type	Attribute	Description
events
credentials	UserCredentials

public async delete(credentials: UserCredentials | null): Promise source

Deletes persistent subscription

Params:

Name	Type	Attribute	Description
credentials	UserCredentials \| null

public eventAppeared(event: Event): void source

Called when event from eventstore arrives

Params:

Name	Type	Attribute	Description
event	Event

public notAcknowledgeEvent(event: Event, reason: *, message: , credentials: UserCredentials): void source

Not acknowledge single event

Params:

Name	Type	Attribute	Description
event	Event
reason	*	optional
message
credentials	UserCredentials

public notAcknowledgeEvents(events: , reason: *, message: , credentials: UserCredentials): void source

Not acknowledge array of events

Params:

Name	Type	Attribute	Description
events
reason	*	optional
message
credentials	UserCredentials

Connects persistent subscription

Params:

Name	Type	Attribute	Description
allowedInFlightMessages	number	optional default: 10
credentials	UserCredentials \| null

public async unsubscribe(credentials: UserCredentials | null): Promise source

Unsubscribe from stream

Params:

Name	Type	Attribute	Description
credentials	UserCredentials \| null

public async update(customConfig: PersistentSubscriptionConfig, credentials: UserCredentials): Promise source

Updates persistent subscription

Params:

Name	Type	Attribute	Description
customConfig	PersistentSubscriptionConfig
credentials	UserCredentials

PersistentSubscription

Extends:

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor() source

Public Members

public allowedInFlightMessages: number source

public autoAcknowledge: boolean source

public id: string source

public lastCommitPosition: Long source

public lastEventNumber: Long | null source

public get name: string source

public get state: SubscriptionStatus source

public set state: SubscriptionStatus source

public stream: Stream source

public subscriptionGroupName: string source

public subscriptionId: string source

Protected Members

protected credentials: UserCredentials | null source

protected esConnection: Eventstore source

protected status: SubscriptionStatus source

Public Methods

public acknowledgeEvent(event: Event, credentials: UserCredentials): void source

Params:

public acknowledgeEvents(events: , credentials: UserCredentials): void source

Params:

public async delete(credentials: UserCredentials | null): Promise source

Params:

public eventAppeared(event: Event): void source

Params:

public notAcknowledgeEvent(event: Event, reason: *, message: , credentials: UserCredentials): void source

Params:

public notAcknowledgeEvents(events: , reason: *, message: , credentials: UserCredentials): void source

Params:

public async subscribe(allowedInFlightMessages: number, credentials: UserCredentials | null): Promise source

Params:

public async unsubscribe(credentials: UserCredentials | null): Promise source

Params:

public async update(customConfig: PersistentSubscriptionConfig, credentials: UserCredentials): Promise source

Params: