Skip to main content

ReactNativeRemote

Extends

Constructors

new ReactNativeRemote()

new ReactNativeRemote(
connector,
logger,
options?): ReactNativeRemote

Parameters

ParameterTypeDefault value
connectorRemoteConnectorundefined
loggerILoggerDEFAULT_REMOTE_LOGGER
options?Partial<AbstractRemoteOptions>undefined

Returns

ReactNativeRemote

Overrides

AbstractRemote.constructor

Accessors

fetch

Get Signature

get fetch(): (input, init?) => Promise<Response>(input, init?) => Promise<Response>(input, init?) => Promise<Response>(input, init?) => Promise<Response>(input, init?) => Promise<Response>(input, init?) => Promise<Response>
Returns

Function

a fetch implementation (function) which can be called to perform fetch requests

MDN Reference

Parameters
ParameterType
inputRequestInfo | URL
init?RequestInit
Returns

Promise<Response>

MDN Reference

Parameters
ParameterType
inputRequestInfo
init?RequestInit
Returns

Promise<Response>

MDN Reference

Parameters
ParameterType
inputRequestInfo
init?RequestInit
Returns

Promise<Response>

MDN Reference

Parameters
ParameterType
inputRequestInfo
init?RequestInit
Returns

Promise<Response>

MDN Reference

Parameters
ParameterType
inputRequestInfo
init?RequestInit
Returns

Promise<Response>

MDN Reference

Parameters
ParameterType
inputstring | Request | URL
init?RequestInit
Returns

Promise<Response>

Inherited from

AbstractRemote.fetch

Methods

fetchCredentials()

fetchCredentials(): Promise<null | PowerSyncCredentials>

Get credentials for PowerSync.

This should always fetch a fresh set of credentials - don't use cached values.

Returns

Promise<null | PowerSyncCredentials>

Inherited from

AbstractRemote.fetchCredentials


get()

get(path, headers?): Promise<any>

Parameters

ParameterType
pathstring
headers?Record<string, string>

Returns

Promise<any>

Inherited from

AbstractRemote.get


getBSON()

getBSON(): Promise<typeof BSON>

Provides a BSON implementation. The import nature of this varies depending on the platform

Returns

Promise<typeof BSON>

Overrides

AbstractRemote.getBSON


getCredentials()

getCredentials(): Promise<null | PowerSyncCredentials>

Get credentials currently cached, or fetch new credentials if none are available.

These credentials may have expired already.

Returns

Promise<null | PowerSyncCredentials>

Inherited from

AbstractRemote.getCredentials


getUserAgent()

getUserAgent(): string

Returns

string

Overrides

AbstractRemote.getUserAgent


invalidateCredentials()

invalidateCredentials(): void

Immediately invalidate credentials.

This may be called when the current credentials have expired.

Returns

void

Inherited from

AbstractRemote.invalidateCredentials


post()

post(
path,
data,
headers?): Promise<any>

Parameters

ParameterType
pathstring
dataany
headers?Record<string, string>

Returns

Promise<any>

Inherited from

AbstractRemote.post


postStream()

postStream(options): Promise<DataStream<StreamingSyncLine>>

Connects to the sync/stream http endpoint

Parameters

ParameterType
optionsSyncStreamOptions

Returns

Promise<DataStream<StreamingSyncLine>>

Overrides

AbstractRemote.postStream


postStreaming()

postStreaming(
path,
data,
headers?,
signal?): Promise<any>

Parameters

ParameterType
pathstring
dataany
headers?Record<string, string>
signal?AbortSignal

Returns

Promise<any>

Inherited from

AbstractRemote.postStreaming


prefetchCredentials()

prefetchCredentials(): Promise<null | PowerSyncCredentials>

Fetch a new set of credentials and cache it.

Until this call succeeds, getCredentials will still return the old credentials.

This may be called before the current credentials have expired.

Returns

Promise<null | PowerSyncCredentials>

Inherited from

AbstractRemote.prefetchCredentials


socketStream()

socketStream(options): Promise<DataStream<StreamingSyncLine>>

Connects to the sync/stream websocket endpoint

Parameters

ParameterType
optionsSocketSyncStreamOptions

Returns

Promise<DataStream<StreamingSyncLine>>

Overrides

AbstractRemote.socketStream