Skip to main content

ConnectionManager

Internal

Extends

Constructors

new ConnectionManager()

new ConnectionManager(options): ConnectionManager

Parameters

ParameterType
optionsConnectionManagerOptions

Returns

ConnectionManager

Overrides

BaseObserver.constructor

Properties

PropertyType
syncStreamImplementation| null | StreamingSyncImplementation

Accessors

activeStreams

Get Signature

get activeStreams(): {
name: string;
params: null | Record<string, any>;
}[]

Internal

exposed for testing

Returns

{ name: string; params: null | Record<string, any>; }[]


connectionOptions

Get Signature

get connectionOptions(): 
| null
| InternalConnectionOptions
Returns

| null | InternalConnectionOptions


connector

Get Signature

get connector(): 
| null
| PowerSyncBackendConnector
Returns

| null | PowerSyncBackendConnector


logger

Get Signature

get logger(): ILogger
Returns

ILogger

Methods

close()

close(): Promise<void>

Returns

Promise<void>


connect()

connect(connector, options): Promise<void>

Parameters

ParameterType
connectorPowerSyncBackendConnector
optionsInternalConnectionOptions

Returns

Promise<void>


disconnect()

disconnect(): Promise<void>

Close the sync connection.

Use connect to connect again.

Returns

Promise<void>


dispose()

dispose(): void

Returns

void

Inherited from

BaseObserver.dispose


iterateAsyncListeners()

iterateAsyncListeners(cb): Promise<void>

Parameters

ParameterType
cb(listener) => Promise<any>

Returns

Promise<void>

Inherited from

BaseObserver.iterateAsyncListeners


iterateListeners()

iterateListeners(cb): void

Parameters

ParameterType
cb(listener) => any

Returns

void

Inherited from

BaseObserver.iterateListeners


registerListener()

registerListener(listener): () => void

Register a listener for updates to the PowerSync client.

Parameters

ParameterType
listenerPartial<ConnectionManagerListener>

Returns

Function

Returns

void

Inherited from

BaseObserver.registerListener


stream()

stream(
adapter,
name,
parameters): SyncStream

Parameters

ParameterType
adapterInternalSubscriptionAdapter
namestring
parametersnull | Record<string, any>

Returns

SyncStream