LiveNamespace
Defined in: packages/pgwasm/src/live/interface.ts:32
The live namespace the extension attaches.
Methods
Section titled “Methods”changes()
Section titled “changes()”Call Signature
Section titled “Call Signature”changes<
T>(query,params,key,callback?):Promise<LiveChanges<T>>
Defined in: packages/pgwasm/src/live/interface.ts:45
The changes to a query’s results, keyed by a column (key) that identifies a row.
Type Parameters
Section titled “Type Parameters”T = Row
Parameters
Section titled “Parameters”string
params
Section titled “params”readonly unknown[] | null | undefined
string
callback?
Section titled “callback?”(changes) => void
Returns
Section titled “Returns”Promise<LiveChanges<T>>
Call Signature
Section titled “Call Signature”changes<
T>(options):Promise<LiveChanges<T>>
Defined in: packages/pgwasm/src/live/interface.ts:51
Type Parameters
Section titled “Type Parameters”T = Row
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<LiveChanges<T>>
incrementalQuery()
Section titled “incrementalQuery()”Call Signature
Section titled “Call Signature”incrementalQuery<
T>(query,params,key,callback?):Promise<LiveQuery<T>>
Defined in: packages/pgwasm/src/live/interface.ts:54
Like query, but maintained from changes, keyed by key: cheaper for large results.
Type Parameters
Section titled “Type Parameters”T = Row
Parameters
Section titled “Parameters”string
params
Section titled “params”readonly unknown[] | null | undefined
string
callback?
Section titled “callback?”(results) => void
Returns
Section titled “Returns”Promise<LiveQuery<T>>
Call Signature
Section titled “Call Signature”incrementalQuery<
T>(options):Promise<LiveQuery<T>>
Defined in: packages/pgwasm/src/live/interface.ts:60
Type Parameters
Section titled “Type Parameters”T = Row
Parameters
Section titled “Parameters”options
Section titled “options”LiveIncrementalQueryOptions<T>
Returns
Section titled “Returns”Promise<LiveQuery<T>>
query()
Section titled “query()”Call Signature
Section titled “Call Signature”query<
T>(query,params?,callback?):Promise<LiveQuery<T>>
Defined in: packages/pgwasm/src/live/interface.ts:37
A query whose results are re-run and delivered whenever a table it reads changes. Resolves to the
initial results plus subscribe / unsubscribe / refresh.
Type Parameters
Section titled “Type Parameters”T = Row
Parameters
Section titled “Parameters”string
params?
Section titled “params?”readonly unknown[] | null
callback?
Section titled “callback?”(results) => void
Returns
Section titled “Returns”Promise<LiveQuery<T>>
Call Signature
Section titled “Call Signature”query<
T>(options):Promise<LiveQuery<T>>
Defined in: packages/pgwasm/src/live/interface.ts:42
Type Parameters
Section titled “Type Parameters”T = Row
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<LiveQuery<T>>